Skip to content

Installation

Jump to bottom
Pietro Bonaldo Gregori edited this page Sep 9, 2024 · 5 revisions

Docker

The available docker images have support for the following platforms: linux/amd64, linux/arm64.

Data path ownership

If the docker container is running as root (which it does by default), then Jetlog will attempt to first change the data path's ownership to the specified user, and then run as that user with gosu. Note that the specified user is PUID:PGID (1000:1000 by default). If Jetlog fails to set the data path's permission for some reason, it will inform you of that in the log and run as root.

Otherwise, if the docker container is not running as root (e.g. if you specified a user in your docker compose), then Jetlog will attempt to run using whatever that user is. This means that if you run the container with a user that doesn't have permission to the data path, Jetlog will fail to start. To fix this, run sudo chown -R PUID:PGID /path/to/jetlog/volume on your machine, changing PUID:PGID to represent whatever user the docker container was running as. Alternatively, you can change the user that the docker container is running as to the user that has ownership of the data path.

Releases

  • :latest will contain tested features and a more stable experience
  • :experimental will contain features that were not thoroughly tested
  • :x.x.x will contain a specific version of the project. Example: :1.0.0

Environment Variables

Name Default Function
JETLOG_PORT 3000 HTTP Port
PGID 1000 Group ID for Jetlog
PUID 1000 User ID for Jetlog
APP_PATH /app Container app path
DATA_PATH /data Container data path

Manual

  1. Clone the repository and cd to it
  2. Install npm dependencies and build frontend 
    npm i --package-lock-only
npm ci
npm run build
  3. Install pipfile dependencies with pipenv 
    pip install pipenv
pipenv install
  4. Open the virtual shell and start the server 
    pipenv shell
(jetlog) export DATA_PATH=/your/data/path
(jetlog) python -m uvicorn main:app --app-dir server --host 0.0.0.0 --port 3000
  5. All done, you can open http://localhost:3000 on your browser to view jetlog
Clone this wiki locally