Blame: README.md - HeyPuter/puter

🌐 The Internet Computer! Free, Open-Source, and Self-Hostable.

0 0 0 JavaScript

Revert "docs: add complete French translation of README (#1936)" This reverts commit cb60b0b1d88a8419045e200bfc03bbed8b4ce80f. 2025-11-07 17:52:19 -05: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>`
Initial commit 2024-03-02 18:39:14 -08:00
Revert "docs: add complete French translation of README (#1936)" This reverts commit cb60b0b1d88a8419045e200bfc03bbed8b4ce80f. 2025-11-07 17:52:19 -05:00			`<h3 align="center">The Internet OS! Free, Open-Source, and Self-Hostable.</h3>`
Initial commit 2024-03-02 18:39:14 -08:00
			`<p align="center">`
Revert "docs: add complete French translation of README (#1936)" This reverts commit cb60b0b1d88a8419045e200bfc03bbed8b4ce80f. 2025-11-07 17:52:19 -05:00			`<a href="https://puter.com/?ref=github.com"><strong>« LIVE DEMO »</strong></a>`
Initial commit 2024-03-02 18:39:14 -08:00			`<br />`
			`<br />`
fix: turns out we don't support `utm_source` I learn something new about Puter every day! 2024-10-20 20:42:34 -07:00			`<a href="https://puter.com/?ref=github.com">Puter.com</a>`
Initial commit 2024-03-02 18:39:14 -08:00			`·`
Fix App Store links and remove install stub 2026-03-22 16:29:13 -07:00			`<a href="https://apps.puter.com/">App Store</a>`
Update README.md 2025-02-24 01:28:37 -08:00			`·`
Revert "docs: add complete French translation of README (#1936)" This reverts commit cb60b0b1d88a8419045e200bfc03bbed8b4ce80f. 2025-11-07 17:52:19 -05:00			`<a href="https://developer.puter.com" target="_blank">Developers</a>`
Initial commit 2024-03-02 18:39:14 -08:00			`·`
Update README.md 2025-02-16 19:46:09 -08:00			`<a href="https://github.com/heyputer/puter-cli" target="_blank">CLI</a>`
			`·`
Initial commit 2024-03-02 18:39:14 -08:00			`<a href="https://discord.com/invite/PQcx7Teh8u">Discord</a>`
			`·`
			`<a href="https://reddit.com/r/puter">Reddit</a>`
			`·`
Update README.md 2025-02-16 19:46:09 -08:00			`<a href="https://twitter.com/HeyPuter">X</a>`
Initial commit 2024-03-02 18:39:14 -08:00			`</p>`

Revert "docs: add complete French translation of README (#1936)" This reverts commit cb60b0b1d88a8419045e200bfc03bbed8b4ce80f. 2025-11-07 17:52:19 -05:00			`<h3 align="center"><img width="800" style="border-radius:5px;" alt="screenshot" src="https://assets.puter.site/puter.com-screenshot-3.webp"></h3>`
Initial commit 2024-03-02 18:39:14 -08:00
			`<br/>`

Update README.md 2024-03-03 20:46:43 -08:00			`## Puter`

Docs: improve clarity in README introduction (#2010) 2025-11-23 23:08:32 +05:30			`Puter is an advanced, open-source internet operating system designed to be feature-rich, fast, and highly extensible. Puter can be used as:`
Remove the FAQ section from README.md 2024-07-07 15:58:17 -07:00
Revert "docs: add complete French translation of README (#1936)" This reverts commit cb60b0b1d88a8419045e200bfc03bbed8b4ce80f. 2025-11-07 17:52:19 -05: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.`
			`- An alternative to Dropbox, Google Drive, OneDrive, etc. with a fresh interface and powerful features.`
			`- A remote desktop environment for servers and workstations.`
			`- A friendly, open-source project and community to learn about web development, cloud computing, distributed systems, and much more!`
Update README.md 2024-03-03 20:46:43 -08:00
Update README.md 2024-03-03 22:15:23 -08:00			`<br/>`

Revert "docs: add complete French translation of README (#1936)" This reverts commit cb60b0b1d88a8419045e200bfc03bbed8b4ce80f. 2025-11-07 17:52:19 -05:00			`## Getting Started`
Initial commit 2024-03-02 18:39:14 -08:00
Add npm and node installation instructions Added installation instructions for npm and node. 2026-02-03 21:35:49 +00:00
Revert "docs: add complete French translation of README (#1936)" This reverts commit cb60b0b1d88a8419045e200bfc03bbed8b4ce80f. 2025-11-07 17:52:19 -05:00			`### 💻 Local Development`
Close #33 2024-03-07 00:00:42 -08:00
Initial commit 2024-03-02 18:39:14 -08:00			```bash
Update README.md 2024-03-03 22:18:22 -08:00			`git clone https://github.com/HeyPuter/puter`
			`cd puter`
Initial commit 2024-03-02 18:39:14 -08:00			`npm install`
			`npm start`
			```
Revert "docs: add complete French translation of README (#1936)" This reverts commit cb60b0b1d88a8419045e200bfc03bbed8b4ce80f. 2025-11-07 17:52:19 -05:00			`→ This should launch Puter at`
			`<font color="red"> http://puter.localhost:4100 (or the next available port). </font>`
doc: make default URL easier to notice * Update README.md Without clear instructions it wasted a few hours just for setting up. Atleast no one will face issues with domain name in localhost now * Making LocalHost website visible * Making LocalHost website visible v2 2025-03-13 21:39:15 +05:30
Revert "docs: add complete French translation of README (#1936)" This reverts commit cb60b0b1d88a8419045e200bfc03bbed8b4ce80f. 2025-11-07 17:52:19 -05:00

			`If this does not work, see [First Run Issues](./doc/self-hosters/first-run-issues.md) for`
			`troubleshooting steps.`
doc: add troubleshooting steps for no build-essentials 2024-10-04 16:02:05 -04:00
Initial commit 2024-03-02 18:39:14 -08:00			`<br/>`

Update README.md 2024-07-07 15:15:19 -07:00			`### 🐳 Docker`
Close #33 2024-03-07 00:00:42 -08:00
			```bash
Update instructions & docker-compose to reflect production paths 2024-04-02 07:45:14 +02: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
Update README instruction to run either with pure Docker, or with Docker Compose 2024-03-31 11:30:12 +02:00			```
Revert "docs: add complete French translation of README (#1936)" This reverts commit cb60b0b1d88a8419045e200bfc03bbed8b4ce80f. 2025-11-07 17:52:19 -05:00			`→ This should launch Puter at`
			`<font color="red"> http://puter.localhost:4100 (or the next available port). </font>`
Update README instruction to run either with pure Docker, or with Docker Compose 2024-03-31 11:30:12 +02:00
Update README.md 2024-07-07 15:03:09 -07:00			`<br/>`

Update README.md 2024-07-07 15:15:19 -07:00			`### 🐙 Docker Compose`
Update README instruction to run either with pure Docker, or with Docker Compose 2024-03-31 11:30:12 +02:00
Bring both Windows and Linux/Mac instructions under Docker Compose 2024-07-16 16:32:42 -07:00			`#### Linux/macOS`
README.en.md translated to Farsi and added to project 2024-09-01 06:18:06 -08:00
Update README instruction to run either with pure Docker, or with Docker Compose 2024-03-31 11:30:12 +02:00			```bash
Update instructions & docker-compose to reflect production paths 2024-04-02 07:45:14 +02:00			`mkdir -p puter/config puter/data`
Fix README instructions following path changes 2024-04-02 07:34:55 +02:00			`sudo chown -R 1000:1000 puter`
Update README instruction to run either with pure Docker, or with Docker Compose 2024-03-31 11:30:12 +02:00			`wget https://raw.githubusercontent.com/HeyPuter/puter/main/docker-compose.yml`
Point users towards compose in README 2024-03-07 18:50:30 +02:00			`docker compose up`
Close #33 2024-03-07 00:00:42 -08:00			```
Revert "docs: add complete French translation of README (#1936)" This reverts commit cb60b0b1d88a8419045e200bfc03bbed8b4ce80f. 2025-11-07 17:52:19 -05:00			`→ This should be available at`
			`<font color="red"> http://puter.localhost:4100 (or the next available port). </font>`
README.en.md translated to Farsi and added to project 2024-09-01 06:18:06 -08:00
Update README.md 2024-07-07 15:03:09 -07:00			`<br/>`

Bring both Windows and Linux/Mac instructions under Docker Compose 2024-07-16 16:32:42 -07:00			`#### Windows`
Update README.md 2024-07-16 09:10:38 -04: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`
			```
Revert "docs: add complete French translation of README (#1936)" This reverts commit cb60b0b1d88a8419045e200bfc03bbed8b4ce80f. 2025-11-07 17:52:19 -05:00			`→ This should launch Puter at`
			`<font color="red"> http://puter.localhost:4100 (or the next available port). </font>`
README.en.md translated to Farsi and added to project 2024-09-01 06:18:06 -08:00
Update README.md 2024-07-16 09:10:38 -04:00			`<br/>`

Revert "docs: add complete French translation of README (#1936)" This reverts commit cb60b0b1d88a8419045e200bfc03bbed8b4ce80f. 2025-11-07 17:52:19 -05:00			`### 🚀 Self-Hosting`
docs: add link to Self-Hosting Documentation in README.md 2024-11-06 17:34:32 -08:00
Revert "docs: add complete French translation of README (#1936)" This reverts commit cb60b0b1d88a8419045e200bfc03bbed8b4ce80f. 2025-11-07 17:52:19 -05:00			`For detailed guides on self-hosting Puter, including configuration options and best practices, see our [Self-Hosting Documentation](https://github.com/HeyPuter/puter/blob/main/doc/self-hosters/instructions.md).`
docs: add link to Self-Hosting Documentation in README.md 2024-11-06 17:34:32 -08:00
			`<br/>`

Update README.md 2024-07-07 15:15:19 -07:00			`### ☁️ Puter.com`

Revert "docs: add complete French translation of README (#1936)" This reverts commit cb60b0b1d88a8419045e200bfc03bbed8b4ce80f. 2025-11-07 17:52:19 -05:00			`Puter is available as a hosted service at [puter.com](https://puter.com).`
Update README.md 2024-07-07 15:15:19 -07:00
Add 'Support' section to README.md 2024-07-09 19:04:09 -07:00			`<br/>`

Revert "docs: add complete French translation of README (#1936)" This reverts commit cb60b0b1d88a8419045e200bfc03bbed8b4ce80f. 2025-11-07 17:52:19 -05:00			`## System Requirements`
Update README.md 2024-08-01 17:04:45 -07:00
Revert "docs: add complete French translation of README (#1936)" This reverts commit cb60b0b1d88a8419045e200bfc03bbed8b4ce80f. 2025-11-07 17:52:19 -05:00			`- Operating Systems: Linux, macOS, Windows`
			`- RAM: 2GB minimum (4GB recommended)`
			`- Disk Space: 1GB free space`
chore: update our required node version (#2204) * feat: fix broken queue bench * chore: update our required node version 2025-12-19 19:24:05 -08:00			`- Node.js: Version 24+`
Revert "docs: add complete French translation of README (#1936)" This reverts commit cb60b0b1d88a8419045e200bfc03bbed8b4ce80f. 2025-11-07 17:52:19 -05:00			`- npm: Latest stable version`
Update README.md 2024-08-01 17:04:45 -07:00
			`<br/>`

Add 'Support' section to README.md 2024-07-09 19:04:09 -07:00			`## Support`

Revert "docs: add complete French translation of README (#1936)" This reverts commit cb60b0b1d88a8419045e200bfc03bbed8b4ce80f. 2025-11-07 17:52:19 -05:00			`Connect with the maintainers and community through these channels:`
Add 'Support' section to README.md 2024-07-09 19:04:09 -07:00
Revert "docs: add complete French translation of README (#1936)" This reverts commit cb60b0b1d88a8419045e200bfc03bbed8b4ce80f. 2025-11-07 17:52:19 -05:00			`- Bug report or feature request? Please [open an issue](https://github.com/HeyPuter/puter/issues/new/choose).`
			`- 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)`
			`- Security issues? [security@puter.com](mailto:security@puter.com)`
			`- Email maintainers at [hi@puter.com](mailto:hi@puter.com)`
Add 'Support' section to README.md 2024-07-09 19:04:09 -07:00
Revert "docs: add complete French translation of README (#1936)" This reverts commit cb60b0b1d88a8419045e200bfc03bbed8b4ce80f. 2025-11-07 17:52:19 -05:00			`We are always happy to help you with any questions you may have. Don't hesitate to ask!`
Add 'Support' section to README.md 2024-07-09 19:04:09 -07:00
Update README.md 2024-07-07 15:15:19 -07:00			`<br/>`

Revert "docs: add complete French translation of README (#1936)" This reverts commit cb60b0b1d88a8419045e200bfc03bbed8b4ce80f. 2025-11-07 17:52:19 -05:00			`## License`
Add ladybird to #DIRP and move the license section to the bottom 2024-07-09 16:54:54 -07:00
Revert "docs: add complete French translation of README (#1936)" This reverts commit cb60b0b1d88a8419045e200bfc03bbed8b4ce80f. 2025-11-07 17:52:19 -05: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.`
Add ladybird to #DIRP and move the license section to the bottom 2024-07-09 16:54:54 -07:00
			`<br/>`
Add link to Danish README in the English Readme 2024-08-14 07:40:37 -07:00
Revert "docs: add complete French translation of README (#1936)" This reverts commit cb60b0b1d88a8419045e200bfc03bbed8b4ce80f. 2025-11-07 17:52:19 -05:00			`## Translations`
Add link to Danish README in the English Readme 2024-08-14 07:40:37 -07:00
Revert "docs: add complete French translation of README (#1936)" This reverts commit cb60b0b1d88a8419045e200bfc03bbed8b4ce80f. 2025-11-07 17:52:19 -05:00			`- [Arabic / العربية](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.ar.md)`
			`- [Armenian / Հայերեն](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.hy.md)`
Add link to Bengali README to English README 2024-08-22 08:22:18 -07:00			`- [Bengali / বাংলা](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.bn.md)`
Revert "docs: add complete French translation of README (#1936)" This reverts commit cb60b0b1d88a8419045e200bfc03bbed8b4ce80f. 2025-11-07 17:52:19 -05:00			`- [Chinese / 中文](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.zh.md)`
			`- [Danish / Dansk](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.da.md)`
			`- [English](https://github.com/HeyPuter/puter/blob/main/README.md)`
fixed translation list alphabetical order 2024-09-14 20:15:59 +05:30			`- [Farsi / فارسی](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.fa.md)`
Revert "docs: add complete French translation of README (#1936)" This reverts commit cb60b0b1d88a8419045e200bfc03bbed8b4ce80f. 2025-11-07 17:52:19 -05:00			`- [Finnish / Suomi](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.fi.md)`
			`- [French / Français](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.fr.md)`
			`- [German / Deutsch](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.de.md)`
			`- [Hebrew/ עברית](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.he.md)`
translate README.md into hindi 2024-08-15 23:01:29 +05:30			`- [Hindi / हिंदी](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.hi.md)`
Revert "docs: add complete French translation of README (#1936)" This reverts commit cb60b0b1d88a8419045e200bfc03bbed8b4ce80f. 2025-11-07 17:52:19 -05:00			`- [Hungarian / Magyar](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.hu.md)`
			`- [Indonesian / Bahasa Indonesia](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.id.md)`
			`- [Italian / Italiano](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.it.md)`
			`- [Japanese / 日本語](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.jp.md)`
			`- [Korean / 한국어](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.ko.md)`
			`- [Malay / Bahasa Malaysia](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.my.md)`
Add link to Malayalam README in the English README 2024-09-04 22:03:26 -04:00			`- [Malayalam / മലയാളം](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.ml.md)`
Revert "docs: add complete French translation of README (#1936)" This reverts commit cb60b0b1d88a8419045e200bfc03bbed8b4ce80f. 2025-11-07 17:52:19 -05:00			`- [Polish / Polski](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.pl.md)`
			`- [Portuguese / Português](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.pt.md)`
docs: add Punjabi translation link to README (#2020) * docs: add Punjabi translation link to README The Punjabi (ਪੰਜਾਬੀ) translation README.pa.md was added 2 weeks ago but was missing from the translations list in the main README. This adds it to maintain completeness of the translations section. * Fix Punjabi link formatting in README.md --------- Co-authored-by: Nariman Jelveh <nj@puter.com> 2025-11-24 22:34:53 +05:30			`- [Punjabi / ਪੰਜਾਬੀ](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.pa.md)`
Revert "docs: add complete French translation of README (#1936)" This reverts commit cb60b0b1d88a8419045e200bfc03bbed8b4ce80f. 2025-11-07 17:52:19 -05:00			`- [Romanian / Română](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.ro.md)`
			`- [Russian / Русский](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.ru.md)`
			`- [Spanish / Español](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.es.md)`
			`- [Swedish / Svenska](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.sv.md)`
			`- [Tamil / தமிழ்](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.ta.md)`
added telugu language translation 2024-10-14 21:40:57 +05:30			`- [Telugu / తెలుగు](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.te.md)`
Revert "docs: add complete French translation of README (#1936)" This reverts commit cb60b0b1d88a8419045e200bfc03bbed8b4ce80f. 2025-11-07 17:52:19 -05:00			`- [Thai / ไทย](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.th.md)`
			`- [Turkish / Türkçe](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.tr.md)`
			`- [Ukrainian / Українська](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.ua.md)`
Update README.md 2024-08-28 14:35:39 -07:00			`- [Urdu / اردو](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.ur.md)`
Revert "docs: add complete French translation of README (#1936)" This reverts commit cb60b0b1d88a8419045e200bfc03bbed8b4ce80f. 2025-11-07 17:52:19 -05:00			`- [Vietnamese / Tiếng Việt](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.vi.md)`