From f7924f30bc74ee59d1de60a010c4c13e68b5a97d Mon Sep 17 00:00:00 2001 From: Nariman Jelveh Date: Wed, 14 Aug 2024 00:59:58 -0700 Subject: [PATCH] Create README.en.md --- doc/i18n/README.en.md | 132 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 132 insertions(+) create mode 100644 doc/i18n/README.en.md diff --git a/doc/i18n/README.en.md b/doc/i18n/README.en.md new file mode 100644 index 000000000..70b4313a5 --- /dev/null +++ b/doc/i18n/README.en.md @@ -0,0 +1,132 @@ +

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.

+ +

+ GitHub repo size GitHub Release GitHub License +

+ +

+ « LIVE DEMO » +
+
+ Puter.com + · + SDK + · + Discord + · + YouTube + · + Reddit + · + X (Twitter) + · + Bug Bounty +

+ +

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 will launch Puter at http://localhost:4000 (or the next available port). + +
+ +### 🐳 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 +``` + +
+ + +### 🐙 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 +``` +
+ +#### 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 +``` +
+ +### ☁️ 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 16+ (Version 22+ recommended) +- **npm:** Latest stable version + +
+ +## Support + +Connect with the maintainers and community through these channels: + +- Bug report or feature request? Please [open an issue](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. + +