Skip to content

cyberkeygen CyberKeyGen

CyberKeyGen is used as a simple password generator.

🛠 Installation

Default Port: 8080

Configuration path: /opt/cyberkeygen

For this installation of CyberKeyGen, the LXC is used to both build and serve the static site. The reason for this to make it easier to build and deploy the site after an update.

npm and vite are used to build the site and an nginx Docker container is used to serve the site.

(
  apt install npm
  git clone https://github.com/karthik558/CyberKeyGen.git /opt/cyberkeygen
  npm install --prefix /opt/cyberkeygen -D vite
  npm run --prefix /opt/cyberkeygen build
  docker run -it --rm -d -p 8080:80 --name web -v /opt/cyberkeygen/dist:/usr/share/nginx/html nginx
)

âš™ Config

They CyberKeyGen source repo is stored in the /opt/cyberkeygen directory and the distribution files are stored in the /opt/cyberkeygen/dist directory after build.

homelab/docker/cyberkeygen/.env

--8<-- "cyberkeygen/.env.tmpl"
homelab/docker/cyberkeygen/compose.yaml 
--8<-- "cyberkeygen/compose.yaml"

Traefik

homelab/pve/traefik/conf.d/cyberkeygen.yaml 
--8<-- "traefik/conf.d/cyberkeygen.yaml"

🚀 Upgrade

To upgrade the CyberKeyGen app, the source repo is pulled and then rebuilt.

The nginx Docker image is managed by Renovate and so and so after a Renovate PR is merged into this repo, this repo is pulled and the Docker container is pulled and restarted.

Warning

The below commands purge any unused Docker images! Use at your own risk!

homelab/docker/cyberkeygen

task upgrade

(
  git pull origin
  git -C /opt/cyberkeygen pull origin
  npm run --prefix /opt/cyberkeygen build
  docker compose up --force-recreate --build -d
  docker image prune -a -f
)

Task List

--8<-- "cyberkeygen/task-list.txt"

🔗 References