Self-hosted Deployment

HamsterBase Tasks is completely free with no paywalls - all features are available at no cost, and we don't collect any of your data. If you'd like to support our development, you can make a donation at https://buymeacoffee.com/hamsterbase.

Installation

Deploy HamsterBase Tasks using Docker with these simple steps:

Quick Start

1. Create a data directory (optional but recommended):

   mkdir data

2. Run the Docker container:

   docker run -d \
     --name hamsterbase-tasks \
     -p 3000:3000 \
     -v ./data:/app/data \
     hamsterbase/tasks

3. Access the application: Open your browser and visit http://localhost:3000

Data Storage

1. By default, data is stored in the browser and will not sync.
2. Synchronization requires additional configuration.

Setting up Synchronization

1. After the server starts, the logs will show something like: Auth token: ed6f99e7-64af-4634-a35a-d86bdca7b619

   By default, a new random token is generated each time the server starts, so it changes on every restart. To keep a stable token across restarts (or use your own), set the AUTH_TOKEN environment variable when starting the container:

   docker run -d \
     --name hamsterbase-tasks \
     -p 3000:3000 \
     -v ./data:/app/data \
     -e AUTH_TOKEN=your-custom-token \
     hamsterbase/tasks

2. Go to Settings

3. Navigate to Self-hosted Settings

4. Click "Add Self-hosted Server"

5. Enter the following information:

   • Endpoint: http://localhost:3000
   • Auth token: (copy the token from your server logs, or use the value you set via AUTH_TOKEN)
   • Folder: You can enter any folder name. Both clients need to set the same folder name for synchronization.