sync-guy/puter
Watch
1
0
Fork
You've already forked puter
 0
mirror of https://github.com/HeyPuter/puter.git synced 2026-11-01 23:06:52 +01:00
Code Issues Projects Releases Packages Wiki Activity
Page: self_hosters instructions
Pages
AI Home README api README api concepts share_link api drivers api group api notifications api share api type_tagged api types app_share api types file_share backend Kernel backend README backend contributors boot_sequence backend contributors modules backend contributors structure backend features protected_apps backend features service_scripts backend howto_make_driver backend lists_of_things list_of_permissions backend lists_of_things list_of_tto_types backend modules puterai requests backend modules test_drivers requests backend notes 2024_10_03_email_in_use_checks contributors comment_prefixes contributors email_testing contributors extensions README contributors extensions definitions contributors extensions events contributors extensions contributors structure contributors vscode devmeta track_comments docmeta gui webpack_attempts phoenix missing_posix phoenix parser planning alternatives_to_$ planning micro_modules prod scratch self_hosters config self_hosters config_values self_hosters credit_context self_hosters domains self_hosters first_run_issues self_hosters instructions self_hosters support src backend A&A auth src backend A&A permission src backend A_and_A auth src backend A_and_A permission src backend Kernel src backend README src backend contributors boot_sequence src backend contributors coding_style src backend contributors modules src backend contributors structure src backend features batch_and_symlinks src backend features metered_services src backend features protected_apps src backend features service_scripts src backend howto_make_driver src backend lists_of_things list_of_permissions src backend lists_of_things list_of_tto_types src backend modules puterai README src backend notes 2024_10_03_email_in_use_checks src backend services config src backend services log src backend src modules puterai README src backend src modules puterai ai_services_config src backend src modules puterai api_examples src backend src modules puterai config src backend src modules puterai contributors ai_usage_testing src backend src modules puterai requests src backend src modules test_drivers requests src gui el() src gui webpack_attempts src phoenix missing_posix src phoenix parser testing_with_email tools api_tester cartesian uncategorized README uncategorized es6_note uncategorized puter_mods
2 self_hosters instructions
KernelDeimos edited this page 2025-02-26 15:01:08 -05:00
Table of contents

Self-Hosting Puter

Warning

The self-hosted version of Puter is currently in alpha stage and should not be used in production yet. It is under active development and may contain bugs, other issues. Please exercise caution and use it for testing and evaluation purposes only.

Self-Hosting Differences

Currently, the self-hosted version of Puter is different in a few ways from Puter.com:

  • There is no built-in way to access apps from puter.com (see below)
  • Several "core" apps are missing, such as Code or Draw
  • Some assets are different

Work is ongoing to improve the App Center and make it available on self-hosted. Until then, it is still possible to add apps using the Dev Center app.


Configuration

Running the server will generate a configuration file in one of these locations:

  • config/config.json when Using Docker
  • volatile/config/config.json in Local Development
  • /etc/puter/config.json on a server (or within a Docker container)

Domain Name

To access Puter on your device, you can simply go to the address printed in the server console (usually puter.localhost:4100).

To access Puter from another device on LAN, enable the following configuration:

"allow_nipio_domains": true

To access Puter from another device, a domain name must be configured, as well as an api subdomain. For example, example.local might be the domain name pointing to the IP address of the server running puter, and api.example.com must point to this address as well. This domain must be specified in the configuration file (usually volatile/config/config.json) as well.

See domain configuration for more information.

Configure the Port

  • You can specify a custom port by setting http_port to a desired value
  • If you're using a reverse-proxy such as nginx or cloudflare, you should also set pub_port to the public (external) port (usually 443)
  • If you have HTTPS enabled on your reverse-proxy, ensure that protocol in config.json is set accordingly

Default User

By default, Puter will create a user called default_user. This user will have a randomly generated password, which will be printed in the development console. A warning will persist in the dev console until this user's password is changed. Please login to this user and change the password as your first step.


General

API

Concepts

Types

For Contributors

Extensions

Devmeta

Planning

  • Micro Modules
  • [planning alternatives_to_](planning-alternatives_to_)

Self_hosters

Src

Backend

A_and_A

For Contributors

Features

Lists_of_things

Modules

Puterai

Notes

Services

Src

Modules
Puterai

####### For Contributors

Test_drivers

Gui

Phoenix

Tools

Api_tester

Uncategorized

This wiki is generated from the repository. Do not edit files the wiki.

You are reading documentation for Puter, an open-source high-level operating system.

Getting started with Puter on localhost is as simple as:

git clone https://github.com/HeyPuter/puter.git
npm install
npm run start