From 4d3101e0157cae08d3cf570fd0abbcb3a0b4b947 Mon Sep 17 00:00:00 2001 From: alagishev Date: Tue, 14 Jan 2025 17:15:30 +0300 Subject: [PATCH] Docs cosmetics --- docs/local_development/local_development.md | 19 +++++++++++++++++-- docs/newcomer_env_setup.md | 2 +- docs/onboarding.md | 6 +++++- 3 files changed, 23 insertions(+), 4 deletions(-) diff --git a/docs/local_development/local_development.md b/docs/local_development/local_development.md index dcbf446..7654dd9 100644 --- a/docs/local_development/local_development.md +++ b/docs/local_development/local_development.md @@ -69,7 +69,7 @@ APIHUB_POSTGRESQL_USERNAME=apihub; APIHUB_POSTGRESQL_PASSWORD=apihub; APIHUB_POSTGRESQL_PORT=5432; PRODUCTION_MODE=false; -JWT_PRIVATE_KEY={use generated key here} +JWT_PRIVATE_KEY={use generated key here}; ``` JSON format @@ -83,9 +83,24 @@ JSON format "JWT_PRIVATE_KEY": "USE GENERATED KEY HERE" ``` - Set these variables to build configuration. +Add the following ENVs in order to have pre-created local admin user and access token. + +ENV format +```INI +APIHUB_ADMIN_EMAIL=; +APIHUB_ADMIN_PASSWORD=; +APIHUB_ACCESS_TOKEN=; +``` + +JSON format +```JSON +"APIHUB_ADMIN_EMAIL": "admin_login, example: apihub" +"APIHUB_ADMIN_PASSWORD": "admin_password, example: password" +"APIHUB_ACCESS_TOKEN": "put_your_key_here - any random string" +``` + #### Run API hub You can simply run Service.go from apihub-service project or you can try to use [`Dockerfile`](/Dockerfile) at your choice. If you will try to use Dockerfile you have to know about the proper image URL which you need to change in the file. diff --git a/docs/newcomer_env_setup.md b/docs/newcomer_env_setup.md index 2422513..5e0c217 100644 --- a/docs/newcomer_env_setup.md +++ b/docs/newcomer_env_setup.md @@ -1,6 +1,6 @@ # Applications to install fo newcomer GO developer -## 1) Install Git (Git Bash) from software center. +## 1) Install Git. Then ask access to GIT repositories listed in Backend sources section of the [Onboarding](onboarding.md) document. ## 2) Install and setup Podman Desktop or Rancher Desktop (your choice). diff --git a/docs/onboarding.md b/docs/onboarding.md index 30404ce..bd74232 100644 --- a/docs/onboarding.md +++ b/docs/onboarding.md @@ -1 +1,5 @@ -TODO \ No newline at end of file +UNDER CONSTRUCTION + +# Repositories list + +todo \ No newline at end of file