Skip to content

Latest commit

 

History

History
27 lines (19 loc) · 1.32 KB

INSTALL.md

File metadata and controls

27 lines (19 loc) · 1.32 KB
Raw

Docker/Podman Deployment

This document assumes that you have installed Docker/Podman already, if you have not yet done so, here are the relevant links for them - Install Docker Desktop, Install Docker Engine, Install Podman.

CLI deployment:

For Docker/Podman (substitute the command name as necessary, I would also recommend using a non-root shell with Podman) - this is not the way I would recommend in general over using Docker Desktop or better yet Docker Compose.

# docker run -d --name fukayo \
 -e FUKAYO_USERNAME=<username> \
 -e FUKAYO_PASSWORD=<password> \
 -p <host_port>:4444 \
 -u "1000:1000" \
 -v <config_dir>:/home/fukayo/.config/fukayo \
 jipaix/fukayo:beta

Docker Desktop deployment:

TBD

Docker Compose deployment:

There is an example docker-compose file included in this repository to be used with docker-compose/docker compose or any other relevant tool such as Portainer. The two less obvious tunables in it (as well as the CLI deployment) are as follows:

  1. <host_port> = The port that your host exposes for Fukayo
  2. <config_dir> = The config directory on your host that you want Fukayo to use