How to install HeyPuter/puter. Official installation instructions. Project installation guide. Framework or library installation. Build installation instructions. How to setup and install from GitHub. Installation steps and setup instructions. Official docs and installation instructions GitHub.
HeyPuter/puter Installation Guide
How to install HeyPuter/puter. Official project installation instructions and setup guide.
⚡
Automated Install (Recommended)
Quick installation instructions for HeyPuter/puter. This is the fastest way to complete project installation and setup.
Install via curl
curl -fsSL https://hexmos.com/ipm-install | bash &&
ipm i HeyPuter/puteror
Install via npx
npx @hexmos/ipm i HeyPuter/puterPrerequisites
Node.js
languageVersion: 20.19.5+ (Version 23+ recommended)
npm
package_managerVersion: latest stable version
Docker
build_toolFor containerizing Puter.
Git
system_toolVersion: latest version
Manual Installation Methods
Manual installation instructions. How to install from GitHub source.
Local Development (Command Line)
git clone https://github.com/HeyPuter/puter.git
cd puter
npm install
npm startDocker (Container)
docker run --rm -p 4100:4100 -v `pwd`/puter/config:/etc/puter -v `pwd`/puter/data:/var/puter ghcr.io/heyputer/puterDocker Compose (Windows)
mkdir -p puter && cd puter && mkdir -p puter/config puter/data && 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/puterPost Installation Steps
- Open your browser and navigate to http://localhost:4100 to access the Puter dashboard.
- If you're using Docker, check the logs for any errors or warnings. If needed, use `docker-compose restart` to restart the container.
