Skip to content
My Own Suite

Getting Started

Use this to run the full stack locally on your machine.

Prerequisites

Section titled “Prerequisites”
  • Docker Desktop installed and running
  • Node.js 20+ and npm
  • Git

1. Clone the repo

Section titled “1. Clone the repo”
Terminal window
git clone https://github.com/rpuls/my-own-suite.git
cd my-own-suite

2. Initialize env files

Section titled “2. Initialize env files”
Terminal window
npm run vps:init

This creates missing .env files from deploy/vps/**/*.env.template without overwriting existing values.

3. Optional customization

Section titled “3. Optional customization”

vps:init auto-generates required secrets from template expressions in *.env.template.

The main first-run values live in deploy/vps/services/suite-manager/.env:

  • OWNER_EMAIL
  • TIMEZONE

You can also change DOMAIN in deploy/vps/.env and adjust individual service env files in deploy/vps/services/*.env if needed.

4. Run environment checks

Section titled “4. Run environment checks”
Terminal window
npm run vps:doctor

This validates required variables and cross-file wiring (including the Radicale token used by Homepage).

5. Build and run the stack

Section titled “5. Build and run the stack”
Terminal window
npm run vps:up

Use this instead of vps:rebuild for normal startup.

If you need a full destructive reset (removes Docker volumes/data):

Terminal window
npm run vps:rebuild

6. Open the apps

Section titled “6. Open the apps”
  • Homepage: http://homepage.localhost/

From Homepage you can open each application. Direct URLs:

  • Seafile: http://seafile.localhost/
  • ONLYOFFICE: http://onlyoffice.localhost/
  • Immich: http://immich.localhost/
  • Radicale: http://radicale.localhost/
  • Stirling PDF: http://stirling-pdf.localhost/
  • Vaultwarden: http://vaultwarden.localhost/