puter

mirror of https://github.com/HeyPuter/puter synced 2024-11-14 22:06:00 +00:00

Go to file

KernelDeimos a1ff375931 doc: update comment_prefixes.md		2024-07-09 03:40:46 -04:00
.github	chore: remove eslint	2024-07-08 00:53:40 -04:00
.vscode	fix: typographical errors 🐛	2024-05-05 08:34:50 +00:00
doc	doc: update comment_prefixes.md	2024-07-09 03:40:46 -04:00
experiments	dev: add js-parse-and-output experiment	2024-07-09 03:40:34 -04:00
mods	test: add more test scenarios for sharing	2024-06-30 15:09:49 -04:00
src	Move icon credits to the GUI project directory	2024-07-08 22:23:02 -07:00
tools	dev: add file walker	2024-07-09 03:15:51 -04:00
volatile	Release backend	2024-03-30 19:08:03 -04:00
.commit	fix: use primary read in signup	2024-04-25 19:46:39 -04:00
.dockerignore	Fix Dockerfile	2024-04-15 19:03:00 -04:00
.env.example	chore: format content 📝	2024-05-06 01:14:36 +00:00
.gitattributes	Initial commit	2024-03-02 18:39:14 -08:00
.gitignore	chore: comment and fine tune `.gitignore` settings 🔨	2024-05-06 01:18:40 +00:00
.is_puter_repository	Release backend	2024-03-30 19:08:03 -04:00
CHANGELOG.md	chore: fix release-please version	2024-07-08 13:47:44 -04:00
CONTRIBUTING.md	Add April-1st-appropriate commit message guidelines	2024-04-01 19:33:11 -04:00
dev-server.js	Migrate to JavaScript modules	2024-03-20 14:10:39 +00:00
docker-compose.yml	Update instructions & docker-compose to reflect production paths	2024-04-02 07:45:14 +02:00
Dockerfile	sync: update gui paths in Dockerfile	2024-07-08 00:31:02 -04:00
eslint.config.js	chore: add Buffer to eslint	2024-07-07 17:12:55 -04:00
exports.js	Release backend	2024-03-30 19:08:03 -04:00
l_checker_config.json	Release backend	2024-03-30 19:08:03 -04:00
LICENSE.txt	Initial commit	2024-03-02 18:39:14 -08:00
package-lock.json	dev: add js-parse-and-output experiment	2024-07-09 03:40:34 -04:00
package.json	dev: add js-parse-and-output experiment	2024-07-09 03:40:34 -04:00
README.md	Move icon credits to the GUI project directory	2024-07-08 22:23:02 -07:00
run-selfhosted.js	fix: Make polyfilled import.meta.filename getter a valid function	2024-06-18 13:17:04 +01:00
SECURITY-ACKNOWLEDGEMENTS.md	Update SECURITY-ACKNOWLEDGEMENTS.md to add Tim's GitHub	2024-03-13 18:55:14 -07:00
SECURITY.md	Create SECURITY.md	2024-03-13 16:33:03 -07:00

README.md

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

« LIVE DEMO »

Puter.com · SDK · Discord · Reddit · X (Twitter) · Bug Bounty

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

git clone https://github.com/HeyPuter/puter
cd puter
cp .env.example .env
npm install
npm start

This will launch Puter at http://localhost:4000 (or the next available port).

🐳 Docker

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

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

☁️ Puter.com

Puter is available as a hosted service at puter.com.

License

This repository is licensed under AGPL-3.0; However, our SDK (puter.js) is also available under Apache 2.0, as indicated by the license file in that section (packages/puter-js) of this repository.