Trying Keygen for the first time (Docker compose structure) #126

joanesinurrietasmartpm · 2024-02-29T15:21:10Z

joanesinurrietasmartpm
Feb 29, 2024

Hello,

in my company we are looking for a licensing tool for our app. I wanted to try Keygen CE locally to test it's capabilities. I created this docker compose following the documentation:

version: '3.5'

services:
  mic-keygen:
    container_name: keygen
    image: keygen/api:v1.2
    ports:
      - 8088:8080
    depends_on:
      - mic-keygen-postgres
      - mic-redis
    environment:
      - KEYGEN_EDITION=CE
      - KEYGEN_ACCOUNT_ID=filled
      - KEYGEN_HOST=api.keygen.localhost
      - DATABASE_URL=postgres://postgres:[email protected]:5433/postgres
      - REDIS_URL=redis://172.18.150.16:6379
      - SECRET_KEY_BASE=filled
      - ENCRYPTION_DETERMINISTIC_KEY=filled
      - ENCRYPTION_PRIMARY_KEY=filled
      - ENCRYPTION_KEY_DERIVATION_SALT=filled
    extra_hosts:
      - host.docker.internal:host-gateway

  mic-keygen-postgres:
    container_name: keygen-postgres
    image: postgres:16.2-alpine3.19
    environment:
      POSTGRES_PASSWORD: postgres
    ports:
      - 5433:5432
    volumes:
      - ./postgres-data:/var/lib/postgresql/data

  mic-redis:
    container_name: keygen-redis
    image: redis:7.2.3-alpine3.18
    ports:
      - 6379:6379
    volumes:
      - ./postgres-data:/var/lib/redis/data

Im using my machine IP because it doesn't work with localhost.

I have this error that I don't know how to resolve because I cannot launch keygen container, it crashes on launch.

024-02-29 14:13:18.295 UTC [28] ERROR:  relation "accounts" does not exist at character 491
keygen-postgres  | 2024-02-29 14:13:18.295 UTC [28] STATEMENT:  SELECT a.attname, format_type(a.atttypid, a.atttypmod),
keygen-postgres  |             pg_get_expr(d.adbin, d.adrelid), a.attnotnull, a.atttypid, a.atttypmod,
keygen-postgres  |             c.collname, col_description(a.attrelid, a.attnum) AS comment,
keygen-postgres  |             attgenerated as attgenerated
keygen-postgres  |        FROM pg_attribute a
keygen-postgres  |        LEFT JOIN pg_attrdef d ON a.attrelid = d.adrelid AND a.attnum = d.adnum
keygen-postgres  |        LEFT JOIN pg_type t ON a.atttypid = t.oid
keygen-postgres  |        LEFT JOIN pg_collation c ON a.attcollation = c.oid AND a.attcollation <> t.typcollation
keygen-postgres  |       WHERE a.attrelid = '"accounts"'::regclass
keygen-postgres  |         AND a.attnum > 0 AND NOT a.attisdropped
keygen-postgres  |       ORDER BY a.attnum

/usr/local/bundle/ruby/3.2.0/gems/activerecord-7.0.7.1/lib/active_record/connection_adapters/postgresql/database_statements.rb:19:in `exec': PG::UndefinedTable: ERROR: relation "accounts" does not exist (ActiveRecord::StatementInvalid) LINE 9: WHERE a.attrelid = '"accounts"'::regclass

With dbeaver I checked 'SELECT * FROM pg_attribute' and 'a.attrelid = '"accounts"' doesn't exist. The table has 3100~ rows but no that one.

Can anyone help me? Thanks in advance.

Answered by ezekg

Sep 14, 2024

We have an official Compose file now: https://github.com/keygen-sh/keygen-api/blob/master/docker-compose.yaml

lmk your thoughts and feedback.

View full answer

ezekg · 2024-03-01T22:16:43Z

ezekg
Mar 1, 2024
Maintainer

The error is saying the accounts table does not exist. This would indicate that you haven't run the setup script, so the database is empty. The setup step is not optional. Here's a discussion on where we're at i.r.t. docker compose: keygen-sh/keygen-api#727

Please keep in mind that Keygen needs its own database; it cannot be shared with another application.

0 replies

joanesinurrietasmartpm · 2024-03-04T15:11:39Z

joanesinurrietasmartpm
Mar 4, 2024
Author

I updated the docker compose file:

version: '3.5'

services:
  mic-keygen-postgres:
    container_name: keygen-postgres
    image: postgres:13.14-alpine
    environment:
      POSTGRES_USER: postgres
      POSTGRES_PASSWORD: postgres
      POSTGRES_DB: postgres
    ports:
      - 5433:5432
    volumes:
      - ./postgres-data:/var/lib/postgresql/data

  mic-keygen-redis:
    container_name: keygen-redis
    image: redis:7.2.3-alpine3.18
    ports:
      - 6379:6379
    volumes:
      - ./redis-data:/var/lib/redis/data

Then I created this launch_keygen.sh file which will fill the DB that was empty and was the origin of the problem:

#!/bin/bash

SECRET_KEY_BASE="filled"
ENCRYPTION_DETERMINISTIC_KEY="filled"
ENCRYPTION_PRIMARY_KEY="filled"
ENCRYPTION_KEY_DERIVATION_SALT="filled"

DATABASE_URL="postgres://postgres:[email protected]:5433/postgres"
REDIS_URL="redis://host.docker.internal:6379"
KEYGEN_HOST="api.keygen.localhost"
KEYGEN_MODE="singleplayer"
KEYGEN_EDITION="CE"
KEYGEN_ACCOUNT_ID="filled"

DOCKER_IMAGE="keygen/api:v1.2"

docker run --rm -it \
  --network keygen_default \
  -e SECRET_KEY_BASE="$SECRET_KEY_BASE" \
  -e ENCRYPTION_DETERMINISTIC_KEY="$ENCRYPTION_DETERMINISTIC_KEY" \
  -e ENCRYPTION_PRIMARY_KEY="$ENCRYPTION_PRIMARY_KEY" \
  -e ENCRYPTION_KEY_DERIVATION_SALT="$ENCRYPTION_KEY_DERIVATION_SALT" \
  -e DATABASE_URL="$DATABASE_URL" \
  -e REDIS_URL="$REDIS_URL" \
  -e KEYGEN_HOST="$KEYGEN_HOST" \
  -e KEYGEN_MODE="$KEYGEN_MODE" \
  -e KEYGEN_EDITION="$KEYGEN_EDITION" \
  -e KEYGEN_ACCOUNT_ID="$KEYGEN_ACCOUNT_ID" \
  "$DOCKER_IMAGE" setup

I was trying to avoid host.docker.internal because in production we have linux environments. I tried using it with windows docker desktop and it worked.

The DB is filled:

Finally, I did a 'docker compose down' of the 2 containers (redis and postgres) but if you notice, I am saving the data from the containers on the host volumes in the parameter 'volumes' of both redis and postgres. Then I add the third keygen container and I do docker compose up again, but now with 3 containers and with the db filled.

version: '3.5'

services:
  mic-keygen-postgres:
    container_name: keygen-postgres
    image: postgres:13.14-alpine
    environment:
      POSTGRES_USER: postgres
      POSTGRES_PASSWORD: postgres
      POSTGRES_DB: postgres
    ports:
      - 5433:5432
    volumes:
      - ./postgres-data:/var/lib/postgresql/data

  mic-keygen-redis:
    container_name: keygen-redis
    image: redis:7.2.3-alpine3.18
    ports:
      - 6379:6379
    volumes:
      - ./redis-data:/var/lib/redis/data

  mic-keygen:
    container_name: keygen
    image: keygen/api:v1.2
    ports:
      - 8088:8080
    depends_on:
      - mic-keygen-postgres
      - mic-keygen-redis
    environment:
      - KEYGEN_EDITION=CE
      - KEYGEN_ACCOUNT_ID=filled
      - KEYGEN_HOST=api.keygen.localhost
      - DATABASE_URL=postgres://postgres:[email protected]:5433/postgres
      - REDIS_URL=redis://172.18.150.16:6379
      - SECRET_KEY_BASE=filled
      - ENCRYPTION_DETERMINISTIC_KEY=filled
      - ENCRYPTION_PRIMARY_KEY=filled
      - ENCRYPTION_KEY_DERIVATION_SALT=filled
    extra_hosts:
      - host.docker.internal:host-gateway

The result:

0 replies

joanesinurrietasmartpm · 2024-03-05T10:03:20Z

joanesinurrietasmartpm
Mar 5, 2024
Author

In the keygen container I see this, the server and worker looks like they are already running and I don't have to execute the server and worker commands. Am I right? (I tried the server run command and the log was identical to the keygen container log). However, how do I manage the keygen service? I don't want to 'docker run' again with all the variables in it because I already have the container with keygen running.

2024-03-05 09:57:47 Running command: bundle exec rails server -b 0.0.0.0 -p 3000
2024-03-05 09:57:49 => Booting Puma
2024-03-05 09:57:49 => Rails 7.0.7.1 application starting in production 
2024-03-05 09:57:49 => Run `bin/rails server --help` for more startup options
2024-03-05 09:57:50 I, [2024-03-05T08:57:49.640187 #1]  INFO -- : [RailsAutoscale] Preparing middleware
2024-03-05 09:57:50 --------------------------------------------------------------------------------
2024-03-05 09:57:50 
2024-03-05 09:57:50                                                 -*%@@@#+:
2024-03-05 09:57:50                                               :%@@@@@@@@@#
2024-03-05 09:57:50                                               @@@@@@@@@@@@#
2024-03-05 09:57:50                                               :@@@@@@@@@@@@@
2024-03-05 09:57:50                                               #@@@@@@@@@@@+
2024-03-05 09:57:50                                                 +@@@@@@@@%=
2024-03-05 09:57:50                                       ::::        -+**+=:
2024-03-05 09:57:50                                   -#@@@@@@#=
2024-03-05 09:57:50                                   #@@@@@@@@@@#.
2024-03-05 09:57:50                                 +@@@@@@@@@@@@+
2024-03-05 09:57:50                                 +@@@@@@@@@@@@#
2024-03-05 09:57:50                                   #@@@@@@@@@@@@=
2024-03-05 09:57:50                                   =%@@@@@@@@@@@*:
2024-03-05 09:57:50                       :=+*+=-       .:--=+%@@@@@@@#**+=:
2024-03-05 09:57:50                     -%@@@@@@@@*            :#@@@@@@@@@@@%=
2024-03-05 09:57:50                     =@@@@@@@@@@@%             *@@@@@@@@@@@@+
2024-03-05 09:57:50                     @@@@@@@@@@@@@-            -@@@@@@@@@@@@@
2024-03-05 09:57:50                     #@@@@@@@@@@@@.             @@@@@@@@@@@@#
2024-03-05 09:57:50                     #@@@@@@@@@%-              :%@@@@@@@@@#.
2024-03-05 09:57:50                       :+#@@@%*-                  -*%@@@#+:
2024-03-05 09:57:50 
2024-03-05 09:57:50 --------------------------------------------------------------------------------
2024-03-05 09:57:50  Ruby: ruby 3.2.3 (2024-01-18 revision 52bb2ac0a6) [x86_64-linux-musl]
2024-03-05 09:57:50  Rails: 7.0.7.1 production (RubyGems 3.4.19, Rack 2.2.6.4)
2024-03-05 09:57:50  Keygen: 1.5.0 (CE, singleplayer)
2024-03-05 09:57:50 --------------------------------------------------------------------------------
2024-03-05 09:57:50 [1] Puma starting in cluster mode...
2024-03-05 09:57:50 [1] * Puma version: 6.4.0 (ruby 3.2.3-p157) ("The Eagle of Durango")
2024-03-05 09:57:50 [1] *  Min threads: 5
2024-03-05 09:57:50 [1] *  Max threads: 5
2024-03-05 09:57:50 [1] *  Environment: production
2024-03-05 09:57:50 [1] *   Master PID: 1
2024-03-05 09:57:50 [1] *      Workers: 2
2024-03-05 09:57:50 [1] *     Restarts: (✔) hot (✖) phased
2024-03-05 09:57:50 [1] * Preloading application
2024-03-05 09:57:50 [1] * Listening on http://0.0.0.0:3000
2024-03-05 09:57:50 [1] Use Ctrl-C to stop
2024-03-05 09:57:50 I, [2024-03-05T08:57:50.803768 #9]  INFO -- : [puma] [9] worker boot event
2024-03-05 09:57:50 [1] - Worker 0 (PID: 9) booted in 0.0s, phase: 0
2024-03-05 09:57:50 I, [2024-03-05T08:57:50.805571 #12]  INFO -- : [puma] [12] worker boot event
2024-03-05 09:57:50 [1] - Worker 1 (PID: 12) booted in 0.0s, phase: 0

1 reply

joanesinurrietasmartpm Mar 5, 2024
Author

It worked with this commands:

docker exec -it keygen bash

bin/rails console

joanesinurrietasmartpm · 2024-03-05T14:41:14Z

joanesinurrietasmartpm
Mar 5, 2024
Author

Rails commands are working:

I added the URL to the hosts with:

echo '127.0.0.1 api.keygen.localhost' | sudo tee -a /etc/hosts

However, I can't connect to the keygen endpoints:

curl -I http://api.keygen.localhost/v1/ping
curl: (7) Failed to connect to api.keygen.localhost port 80 after 0 ms: Connection refused

2 replies

ezekg Mar 7, 2024
Maintainer

If Keygen is running, but you're unable to connect, then that would indicate an issue with your reverse proxy configuration.

AliBello Sep 13, 2024

I found the problem, Keygen is listening on port 3000.

ezekg · 2024-09-14T12:51:23Z

ezekg
Sep 14, 2024
Maintainer

We have an official Compose file now: https://github.com/keygen-sh/keygen-api/blob/master/docker-compose.yaml

lmk your thoughts and feedback.

0 replies

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Keygen

Trying Keygen for the first time (Docker compose structure) #126

{{title}}

{{editor}}'s edit

{{editor}}'s edit

Replies: 5 comments 3 replies

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{editor}}'s edit

{{editor}}'s edit

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

{{title}}

Select a reply

Keygen

Trying Keygen for the first time (Docker compose structure) #126

joanesinurrietasmartpm Feb 29, 2024

Replies: 5 comments · 3 replies

ezekg Mar 1, 2024 Maintainer

joanesinurrietasmartpm Mar 4, 2024 Author

joanesinurrietasmartpm Mar 5, 2024 Author

joanesinurrietasmartpm Mar 5, 2024 Author

joanesinurrietasmartpm Mar 5, 2024 Author

ezekg Mar 7, 2024 Maintainer

AliBello Sep 13, 2024

ezekg Sep 14, 2024 Maintainer

joanesinurrietasmartpm
Feb 29, 2024

Replies: 5 comments 3 replies

ezekg
Mar 1, 2024
Maintainer

joanesinurrietasmartpm
Mar 4, 2024
Author

joanesinurrietasmartpm
Mar 5, 2024
Author

joanesinurrietasmartpm Mar 5, 2024
Author

joanesinurrietasmartpm
Mar 5, 2024
Author

ezekg Mar 7, 2024
Maintainer

ezekg
Sep 14, 2024
Maintainer