diff --git a/README.hi.md b/README.hi.md new file mode 100644 index 000000000..2fd87e73f --- /dev/null +++ b/README.hi.md @@ -0,0 +1,184 @@ +

Puter.com, The Personal Cloud Computer: All your files, apps, and games in one place accessible from anywhere at any time.

+ +

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

+ +

+ « LIVE DEMO » +
+
+ Puter.com + · + App Store + · + Developers + · + CLI + · + Discord + · + Reddit + · + X +

+ +

screenshot

+ +
+ +## Puter + +Puter is an advanced, open-source internet operating system designed to be feature-rich, exceptionally fast, and highly extensible. Puter can be used as: + +- 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! + +
+ +## Getting Started + +### 💻 Local Development + +```bash +git clone https://github.com/HeyPuter/puter +cd puter +npm install +npm start +``` +**→** This should launch Puter at + http://puter.localhost:4100 (or the next available port). + + + +If this does not work, see [First Run Issues](./doc/self-hosters/first-run-issues.md) for +troubleshooting steps. + +
+ +### 🐳 Docker + +```bash +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 +``` +**→** This should launch Puter at + http://puter.localhost:4100 (or the next available port). + +
+ +### 🐙 Docker Compose + +#### Linux/macOS + +```bash +mkdir -p puter/config puter/data +sudo chown -R 1000:1000 puter +wget https://raw.githubusercontent.com/HeyPuter/puter/main/docker-compose.yml +docker compose up +``` +**→** This should be available at + http://puter.localhost:4100 (or the next available port). + +
+ +#### Windows + +```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 +``` +**→** This should launch Puter at + http://puter.localhost:4100 (or the next available port). + +
+ +### 🚀 Self-Hosting + +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). + +
+ +### ☁️ Puter.com + +Puter is available as a hosted service at [**puter.com**](https://puter.com). + +
+ +## System Requirements + +- **Operating Systems:** Linux, macOS, Windows +- **RAM:** 2GB minimum (4GB recommended) +- **Disk Space:** 1GB free space +- **Node.js:** Version 20.19.5+ (Version 23+ recommended) +- **npm:** Latest stable version + +
+ +## Support + +Connect with the maintainers and community through these channels: + +- 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) + +We are always happy to help you with any questions you may have. Don't hesitate to ask! + +
+ +## License + +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. + +
+ +## Translations + +- [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) +- [Bengali / বাংলা](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.bn.md) +- [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) +- [Farsi / فارسی](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.fa.md) +- [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) +- [Hindi / हिंदी](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.hi.md) +- [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) +- [Malayalam / മലയാളം](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.ml.md) +- [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) +- [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) +- [Telugu / తెలుగు](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.te.md) +- [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) +- [Urdu / اردو](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.ur.md) +- [Vietnamese / Tiếng Việt](https://github.com/HeyPuter/puter/blob/main/doc/i18n/README.vi.md) + + +## Links to Other READMEs +### Backend +- [PuterAI Module](./src/backend/doc/modules/puterai/README.md) +- [Metering Service](./src/backend/src/services/MeteringService/README.md) +- [Extensions Development Guide](./extensions/README.md)