Skip to content

Getting Started

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

Prerequisites

  • Docker Desktop installed and running
  • Node.js 20+ and npm
  • Git

1. Clone the repo

Terminal window
git clone https://github.com/rpuls/my-own-suite.git
cd my-own-suite

2. Create local env files

From deploy/vps:

Terminal window
cp .env.example .env
cp apps/homepage/.env.example apps/homepage/.env
cp apps/seafile/.env.example apps/seafile/.env
cp apps/onlyoffice/.env.example apps/onlyoffice/.env
cp apps/immich/.env.example apps/immich/.env
cp apps/radicale/.env.example apps/radicale/.env
cp apps/stirling-pdf/.env.example apps/stirling-pdf/.env
cp apps/vaultwarden/.env.example apps/vaultwarden/.env

If you are on PowerShell, use Copy-Item instead of cp.

Required values to set before first run:

  • deploy/vps/apps/seafile/.env
    • MYSQL_ROOT_PASSWORD
    • DB_ROOT_PASSWD
    • SEAFILE_ADMIN_EMAIL
    • SEAFILE_ADMIN_PASSWORD
    • SEAFILE_SERVER_HOSTNAME (for local: seafile.localhost)

3. Build and run everything

From repo root:

Terminal window
npm run vps:rebuild

This command fully resets and rebuilds the stack (it removes Docker volumes/data).

4. Open the apps

  • Homepage: http://homepage.localhost/

From Homepage you can open any application, dashboard style. Each app can also be found on its dedicated URL:

  • 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/