2024-03-04 22:37:30 +00:00
< h3 align = "center" > < img width = "80" alt = "Puter.com, The Personal Cloud Computer: All your files, apps, and games in one place accessible from anywhere at any time." src = "https://assets.puter.site/puter-logo.png" > < / h3 >
2024-03-03 02:39:14 +00:00
2024-04-21 19:50:58 +00:00
< h3 align = "center" > The Internet OS! Free, Open-Source, and Self-Hostable.< / h3 >
2024-03-03 02:39:14 +00:00
2024-07-25 10:22:24 +00:00
< p align = "center" >
2024-07-25 11:00:28 +00:00
< img alt = "GitHub repo size" src = "https://img.shields.io/github/repo-size/HeyPuter/puter" > < img alt = "GitHub Release" src = "https://img.shields.io/github/v/release/HeyPuter/puter?label=latest%20version" > < img alt = "GitHub License" src = "https://img.shields.io/github/license/HeyPuter/puter" >
2024-07-25 10:22:24 +00:00
< / p >
2024-03-03 02:39:14 +00:00
< p align = "center" >
< a href = "https://puter.com/" > < strong > « LIVE DEMO »< / strong > < / a >
< br / >
< br / >
< a href = "https://puter.com" > Puter.com< / a >
·
< a href = "https://docs.puter.com" target = "_blank" > SDK< / a >
·
< a href = "https://discord.com/invite/PQcx7Teh8u" > Discord< / a >
·
2024-08-14 03:42:40 +00:00
< a href = "https://www.youtube.com/@EricsPuterVideos" > YouTube< / a >
·
2024-03-03 02:39:14 +00:00
< a href = "https://reddit.com/r/puter" > Reddit< / a >
·
< a href = "https://twitter.com/HeyPuter" > X (Twitter)< / a >
2024-04-21 22:04:49 +00:00
·
< a href = "https://hackerone.com/puter_h1b" > Bug Bounty< / a >
2024-03-03 02:39:14 +00:00
< / p >
2024-07-16 22:56:59 +00:00
< h3 align = "center" > < img width = "800" style = "border-radius:5px;" alt = "screenshot" src = "https://assets.puter.site/puter.com-screenshot-3.webp" > < / h3 >
2024-03-03 02:39:14 +00:00
< br / >
2024-03-04 04:46:43 +00:00
## Puter
2024-07-07 22:58:17 +00:00
Puter is an advanced, open-source internet operating system designed to be feature-rich, exceptionally fast, and highly extensible. Puter can be used as:
2024-07-07 23:38:12 +00:00
- A privacy-first personal cloud to keep all your files, apps, and games in one secure place, accessible from anywhere at any time.
- A platform for building and publishing websites, web apps, and games.
2024-07-07 23:09:07 +00:00
- An alternative to Dropbox, Google Drive, OneDrive, etc. with a fresh interface and powerful features.
2024-07-07 23:38:12 +00:00
- A remote desktop environment for servers and workstations.
2024-07-07 22:58:17 +00:00
- A friendly, open-source project and community to learn about web development, cloud computing, distributed systems, and much more!
2024-03-04 04:46:43 +00:00
2024-03-04 06:15:23 +00:00
< br / >
2024-03-03 02:39:14 +00:00
## Getting Started
2024-07-07 22:09:49 +00:00
### 💻 Local Development
2024-03-07 08:00:42 +00:00
2024-03-03 02:39:14 +00:00
```bash
2024-03-04 06:18:22 +00:00
git clone https://github.com/HeyPuter/puter
cd puter
2024-03-03 02:39:14 +00:00
npm install
npm start
```
2024-08-14 17:54:09 +00:00
This will launch Puter at http://puter.localhost:4100 (or the next available port).
2024-03-03 02:39:14 +00:00
< br / >
2024-07-07 22:15:19 +00:00
### 🐳 Docker
2024-03-07 08:00:42 +00:00
```bash
2024-04-02 05:45:14 +00:00
mkdir puter && cd puter && mkdir -p puter/config puter/data && sudo chown -R 1000:1000 puter && docker run --rm -p 4100:4100 -v `pwd` /puter/config:/etc/puter -v `pwd` /puter/data:/var/puter ghcr.io/heyputer/puter
2024-03-31 09:30:12 +00:00
```
2024-07-07 22:03:09 +00:00
< br / >
2024-07-07 22:15:19 +00:00
### 🐙 Docker Compose
2024-03-31 09:30:12 +00:00
2024-07-16 23:32:42 +00:00
#### Linux/macOS
2024-09-01 14:18:06 +00:00
2024-03-31 09:30:12 +00:00
```bash
2024-04-02 05:45:14 +00:00
mkdir -p puter/config puter/data
2024-04-02 05:34:55 +00:00
sudo chown -R 1000:1000 puter
2024-03-31 09:30:12 +00:00
wget https://raw.githubusercontent.com/HeyPuter/puter/main/docker-compose.yml
2024-03-07 16:50:30 +00:00
docker compose up
2024-03-07 08:00:42 +00:00
```
2024-09-01 14:18:06 +00:00
2024-07-07 22:03:09 +00:00
< br / >
2024-07-16 23:32:42 +00:00
#### Windows
2024-07-16 13:10:38 +00:00
```powershell
mkdir -p puter
cd puter
New-Item -Path "puter\config" -ItemType Directory -Force
New-Item -Path "puter\data" -ItemType Directory -Force
Invoke-WebRequest -Uri "https://raw.githubusercontent.com/HeyPuter/puter/main/docker-compose.yml" -OutFile "docker-compose.yml"
docker compose up
```
2024-09-01 14:18:06 +00:00
2024-07-16 13:10:38 +00:00
< br / >
2024-07-07 22:15:19 +00:00
### ☁️ Puter.com
2024-07-07 22:22:06 +00:00
Puter is available as a hosted service at [**puter.com** ](https://puter.com ).
2024-07-07 22:15:19 +00:00
2024-07-10 02:04:09 +00:00
< br / >
2024-08-02 00:04:45 +00:00
## System Requirements
- **Operating Systems:** Linux, macOS, Windows
- **RAM:** 2GB minimum (4GB recommended)
- **Disk Space:** 1GB free space
- **Node.js:** Version 16+ (Version 22+ recommended)
- **npm:** Latest stable version
< br / >
2024-07-10 02:04:09 +00:00
## Support
2024-07-10 02:18:14 +00:00
Connect with the maintainers and community through these channels:
2024-07-10 02:04:09 +00:00
2024-08-14 19:38:00 +00:00
- Bug report or feature request? Please [open an issue ](https://github.com/HeyPuter/puter/issues/new/choose ).
2024-07-14 23:43:56 +00:00
- Discord: [discord.com/invite/PQcx7Teh8u ](https://discord.com/invite/PQcx7Teh8u )
- X (Twitter): [x.com/HeyPuter ](https://x.com/HeyPuter )
- Reddit: [reddit.com/r/puter/ ](https://www.reddit.com/r/puter/ )
- Mastodon: [mastodon.social/@puter ](https://mastodon.social/@puter )
2024-08-13 02:20:21 +00:00
- Security issues? [security@puter.com ](mailto:security@puter.com )
2024-07-10 02:04:09 +00:00
- Email maintainers at [hi@puter.com ](mailto:hi@puter.com )
2024-07-10 02:15:50 +00:00
We are always happy to help you with any questions you may have. Don't hesitate to ask!
2024-07-10 02:04:09 +00:00
2024-07-07 22:15:19 +00:00
< br / >
2024-09-01 14:18:06 +00:00
## License
2024-07-09 23:54:54 +00:00
This repository, including all its contents, sub-projects, modules, and components, is licensed under [AGPL-3.0 ](https://github.com/HeyPuter/puter/blob/main/LICENSE.txt ) unless explicitly stated otherwise. Third-party libraries included in this repository may be subject to their own licenses.
< br / >
2024-08-14 14:40:37 +00:00
## Translations
2024-08-26 07:54:05 +00:00
- [Arabic / العربية ](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.ar.md )
2024-09-03 15:55:05 +00:00
- [Armenian / Հայերեն ](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.hy.md )
2024-08-22 15:22:18 +00:00
- [Bengali / বাংলা ](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.bn.md )
2024-08-20 02:36:20 +00:00
- [Chinese / 中文 ](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.zh.md )
2024-08-14 14:40:37 +00:00
- [Danish / Dansk ](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.da.md )
- [English ](https://github.com/HeyPuter/puter/blob/main/README.md )
2024-09-14 14:45:59 +00:00
- [Farsi / فارسی ](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.fa.md )
2024-08-31 04:19:04 +00:00
- [Finnish / Suomi ](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.fi.md )
2024-08-28 20:07:12 +00:00
- [French / Français ](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.fr.md )
2024-09-14 14:47:02 +00:00
- [German/ Deutsch ](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.de.md )
2024-08-31 18:41:49 +00:00
- [Hebrew/ עברית ](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.he.md )
2024-08-15 17:31:29 +00:00
- [Hindi / हिंदी ](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.hi.md )
2024-09-10 15:59:41 +00:00
- [Hungarian / Magyar ](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.hu.md )
2024-08-23 17:28:27 +00:00
- [Indonesian / Bahasa Indonesia ](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.id.md )
2024-08-21 21:11:16 +00:00
- [Italian / Italiano ](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.it.md )
2024-08-15 22:06:55 +00:00
- [Japanese / 日本語 ](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.jp.md )
2024-08-26 16:22:39 +00:00
- [Korean / 한국어 ](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.ko.md )
2024-09-05 02:03:26 +00:00
- [Malayalam / മലയാളം ](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.ml.md )
2024-08-26 16:22:39 +00:00
- [Polish / Polski ](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.pl.md )
2024-08-14 15:23:09 +00:00
- [Portuguese / Português ](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.pt.md )
2024-08-24 06:08:15 +00:00
- [Romanian / Română ](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.ro.md )
2024-08-24 06:09:04 +00:00
- [Russian / Русский ](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.ru.md )
2024-08-14 22:05:51 +00:00
- [Spanish / Español ](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.es.md )
2024-09-14 14:46:35 +00:00
- [Swedish / Svenska ](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.sv.md )
2024-08-22 19:52:17 +00:00
- [Tamil / தமிழ் ](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.ta.md )
2024-08-25 19:30:42 +00:00
- [Thai / ไทย ](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.th.md )
2024-08-17 16:53:38 +00:00
- [Turkish / Türkçe ](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.tr.md )
2024-09-07 16:50:04 +00:00
- [Ukrainian / Українська ](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.ua.md )
2024-08-28 21:35:39 +00:00
- [Urdu / اردو ](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.ur.md )
2024-08-18 18:22:17 +00:00
- [Vietnamese / Tiếng Việt ](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.vi.md )
