Skip to content

Installation

Follow these steps to install and set up Snykey.

1. Clone the Repository

git clone https://github.com/Will-Hellinger/snykey.git
cd snykey

2. Prepare Configuration

Copy .env_example to .env and fill in your secrets and environment-specific values. Adjust any configuration in configs/ if needed.

3. Run the Setup Script

The setup script will:

  • Create required directories and volume mounts
  • Copy configuration files for OpenBao and Redis
  • Generate self-signed certificates for local development

Run: sh /scripts/setup.sh

4. Start the Stack

Start all services with Docker Compose:

docker compose up -d --build

5. Initialize and Unseal OpenBao

a. Initialize OpenBao (first time only):

docker exec -it openbao bao operator init -n 1 -t 1
  • Save the Unseal Key and Root Token from the output.
  • Add them to your .env file as OPENBAO_UNSEAL_KEY and OPENBAO_TOKEN.

b. Restart the Stack

docker compose down

docker compose up -d

c. Unseal OpenBao:

docker exec -it openbao bao operator unseal $OPENBAO_UNSEAL_KEY

d. Login to OpenBao:

docker exec -it openbao bao login $OPENBAO_TOKEN

6. Enable the Key-Value Secrets Engine

Enable the KV secrets engine (version 2):

docker exec -it openbao bao secrets enable -version=2 kv

7. (Optional) Verify Everything is Running

  • Visit https://localhost:8000/docs for the API docs.
  • Check logs in .container_volumes/app/logs/ if needed.

8. Next Steps

  • Use the API to store and retrieve Snyk credentials for your applications.
  • For production, replace the generated certificates with your own trusted certificates.