bthlabs/hotpocket repository overview

⁠HotPocket by BTHLabs

HotPocket is a minimal, open-source bookmarking app. Save links from all the major browsers, across mobile and desktop devices. Built to be self-hosted, HotPocket puts you in control of your data.

⁠Available images

There are two deployment images - aio and deployment.

⁠The AIO image

The aio image is pre-configured for running small instances in a single container:

• It defaults to SQLite database.
• It defaults to running all background tasks in the foreground.
• It defaults to accepting traffic with any Host HTTP header.

The aio image is recommended for self-hosting with minimal use, e.g. by a single user.

Example:

$ docker run --rm -it \
    -v `realpath run/`:/srv/run \
    -e HOTPOCKET_BACKEND_SECRET_KEY=thisisntright \
    -e HOTPOCKET_BACKEND_INITIAL_ACCOUNT_USERNAME=hotpocket \
    -e HOTPOCKET_BACKEND_INITIAL_ACCOUNT_PASSWORD=hotpocketm4st3r \
    -p 8000:8000 \
    bthlabs/hotpocket:aio-v25.11.26-01

The command above will set up and start the application. The SQLite file will be placed in run/hotpocket-backend-aio.sqlite and database migrations will be ran. The initial superuser account will be created with the specified credentials. The Web app will be reachable at http://127.0.0.1:8000/. The admin will be reachable at http://127.0.0.1:8000/admin/.

The DJANGO_SETTINGS_MODULE environment variable defaults to hotpocket_backend.settings.deployment.aio.

NOTE: The command above specifies wildly insecure SECRET_KEY which is used among other things to secure the session cookie. Please please please don't run it like this. Not even in your homelab :).

The deployment/aio/docker-compose.yaml⁠ file can be used as a starting point for AIO deployments.

⁠The Deployment image

The deployment image doesn't make any assumptions about the env and in turn will require the operator to configure database, Celery broker and result backend etc. The final deployment will require services for at least the Web app, the Celery worker and Celery Beat. Admin is optional.

The DJANGO_SETTINGS_MODULE environment variable defaults to hotpocket_backend.settings.deployment.webapp. This should be set to hotpocket_backend.settings.deployment.admin in the Admin container.

The deployment/fullstack/docker-compose.yaml⁠ file can be used as a starting point for full-stack deployments.

⁠Configuration environment variables

HotPocket deployment images provide extensive set of environment variables that can be used to configure the services.

Env and App settings

The HOTPOCKET_BACKEND_ENV and HOTPOCKET_BACKEND_APP variables are used internally to resolve other settings and identify the running app. HOTPOCKET_BACKEND_ENV should only be changed if when creating heavily customized version of the project. HOTPOCKET_BACKEND_APP should generally be set to admin only in the Admin container.

OIDC login configuration

The HOTPOCKET_BACKEND_OIDC_PAYLOAD can be used to enable OIDC login. It must be a JSON string that deserializes to the following object:

{
  "endpoint": "https://some.oidc.host/some-realm/",
  "key": "client-key",
  "secret": "client-secret",
  "scope": ["roles"],
  "display_name": "My OIDC server"
}

The scope field specified additional scopes to request from IdP. It can be ommited and defaults to ["roles"]. The display_name field specifies the method's name in the UI and defaults to OIDC.

NOTE: Currently, only Keycloak has been tested with this login method.

⁠Volumes

Both images declare /srv/run to be a volume. It's intended to keep the service's runtime data, including but not limited to PID files, UNIX sockets etc. It's recommended to persist this volume.

Additionally, the deployment image declares /srv/uploads to be a volume. It's recommeded to persist this volume.

⁠Author

HotPocket is developed by BTHLabs⁠.

⁠License

HotPocket is licensed under the Apache 2.0 License.