Docker (5 seconds) #

You can download the latest version via hamsterbase/hamsterbase:latest, hamsterbase/hamsterbase:latest-arm.

docker run \
 -d --rm \
 --name hamsterbase \
 --publish 3001:3001 \
 --volume ~/.hamsterbase/data:/app/data \
 hamsterbase/hamsterbase:latest \
  --port 3001  \
  --password 123

Then, HamsterBase will be launched at http://localhost:3001 and store its data in ~/.hamsterbase/data directory.

arguments #

--port: specifies the port number the server listens on, default is 3001.

--password: specifies the password for the server. Even though hamsterbase supports setting passwords, we still do not recommend exposing hamsterbase to the internet.

If you want to use it in docker-compose, you can refer to the configuration below.

version: "3"

services:
  hamsterbase:
    image: hamsterbase/hamsterbase:latest
    container_name: hamsterbase
    restart: always
    ports:
      - 3001:3001
    volumes:
      - ~/.hamsterbase/data:/app/data
    command: "--port 3001 --password 123"