mirror of
https://github.com/HeyPuter/puter
synced 2024-11-15 06:15:47 +00:00
133 lines
4.3 KiB
Markdown
133 lines
4.3 KiB
Markdown
<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>
|
|
|
|
<h3 align="center">The Internet OS! Free, Open-Source, and Self-Hostable.</h3>
|
|
|
|
<p align="center">
|
|
<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">
|
|
</p>
|
|
|
|
<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>
|
|
·
|
|
<a href="https://www.youtube.com/@EricsPuterVideos">YouTube</a>
|
|
·
|
|
<a href="https://reddit.com/r/puter">Reddit</a>
|
|
·
|
|
<a href="https://twitter.com/HeyPuter">X (Twitter)</a>
|
|
·
|
|
<a href="https://hackerone.com/puter_h1b">Bug Bounty</a>
|
|
</p>
|
|
|
|
<h3 align="center"><img width="800" style="border-radius:5px;" alt="screenshot" src="https://assets.puter.site/puter.com-screenshot-3.webp"></h3>
|
|
|
|
<br/>
|
|
|
|
## 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!
|
|
|
|
<br/>
|
|
|
|
## 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).
|
|
|
|
<br/>
|
|
|
|
### 🐳 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
|
|
```
|
|
|
|
<br/>
|
|
|
|
|
|
### 🐙 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
|
|
```
|
|
<br/>
|
|
|
|
#### 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
|
|
```
|
|
<br/>
|
|
|
|
### ☁️ Puter.com
|
|
|
|
Puter is available as a hosted service at [**puter.com**](https://puter.com).
|
|
|
|
<br/>
|
|
|
|
## 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/>
|
|
|
|
## 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!
|
|
|
|
<br/>
|
|
|
|
|
|
## 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.
|
|
|
|
<br/>
|