m306-TouGH-Vault-github-backupper

Frontend

An example of a client can be found at https://github.com/jzelAdmin2006/m306-TouGH-Vault-github-backupper-frontend. It was not the focus of our project, the centrepiece is definitely the server, i.e. this repo, but although it is not perfect, it is simple and intuitive.

Architecture

How to use

How to run TouGH-Vault with Docker (use corresponding realm export, client secret has to be set before importing):

docker network create TouGH-Vault
docker volume create kc-postgres
docker run -d \
    --network TouGH-Vault \
    --name Keycloak-postgres \
    -e POSTGRES_PASSWORD=admin \
    -e POSTGRES_DB=postgres \
    -e POSTGRES_USER=postgres \
    -v kc-postgres:/var/lib/postgresql/data \
    -p 5433:5432 \
    postgres
docker run --name TouGH-Vault-Keycloak -d -p 18080:8080 \
    -e KEYCLOAK_ADMIN=admin -e KEYCLOAK_ADMIN_PASSWORD=admin \
    -e PROXY_ADDRESS_FORWARDING=true \
    -e KEYCLOAK_FRONTEND_URL=https://tough-vault-keycloak.jzel.online \
    -e KC_HTTP_ENABLED=false -e KC_HOSTNAME_STRICT_HTTPS=true \
    -e KC_PROXY=edge \
    -e KC_HOSTNAME=tough-vault-keycloak.jzel.online \
    -e DB_VENDOR=postgres \
    -e DB_ADDR=Keycloak-postgres \
    -e DB_PORT=5433 \
    -e DB_DATABASE=keycloak \
    -e DB_USER=keycloak \
    -e DB_PASSWORD=admin \
    --network TouGH-Vault \
    quay.io/keycloak/keycloak:23.0.7 start
docker volume create postgres
docker run -d \
    --network TouGH-Vault \
	--name TouGH-Vault-postgres \
	-e POSTGRES_PASSWORD=admin \
	-e PGDATA=/var/lib/postgresql/data/pgdata \
	-v postgres:/var/lib/postgresql/data \
	-p 5432:5432 \
	postgres
docker run --network TouGH-Vault --name TouGH-Vault -d --env-file ./.env -p 8080:8080 jzeladmin2006/tough-vault
docker run --name TouGH-Vault-frontend -d -p 4200:8080 jzeladmin2006/tough-vault-frontend

How to remove TouGH-Vault entirely:

docker stop TouGH-Vault-Keycloak
docker stop TouGH-Vault-postgres
docker stop TouGH-Vault
docker stop TouGH-Vault-frontend
docker remove TouGH-Vault-Keycloak
docker remove TouGH-Vault-postgres
docker remove TouGH-Vault
docker remove TouGH-Vault-frontend
docker network remove TouGH-Vault
docker volume remove postgres

How to start Keycloak container for TouGH-Vault development purposes (use corresponding realm export, client secret has to be set before importing):

docker run --name TouGH-Vault-Keycloak -d -p 18080:8080 -e KEYCLOAK_ADMIN=admin -e KEYCLOAK_ADMIN_PASSWORD=admin \
  -e KEYCLOAK_FRONTEND_URL=localhost:18080 quay.io/keycloak/keycloak:23.0.7 start-dev

TODO: fix Keycloak persistence by doing something like this ( using https://www.decomposerize.com/): https://keycloak.discourse.group/t/setup-keycloak-version-21-0-2-with-postgres-using-docker/21345/2

For now, this app won't be listed in the GitHub Marketplace because according to the requirements, the app mustn't be in beta and fully usable in production for any user: https://docs.github.com/en/apps/github-marketplace/creating-apps-for-github-marketplace/requirements-for-listing-an-app Thus, at the moment, only an unlisted public page for the demo deployment exists: https://github.com/apps/tough-vault-demo-deployment