Skip to content

Commit 4d3101e

Browse files
committed
Docs cosmetics
1 parent 1593b30 commit 4d3101e

File tree

3 files changed

+23
-4
lines changed

3 files changed

+23
-4
lines changed

docs/local_development/local_development.md

Lines changed: 17 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -69,7 +69,7 @@ APIHUB_POSTGRESQL_USERNAME=apihub;
6969
APIHUB_POSTGRESQL_PASSWORD=apihub;
7070
APIHUB_POSTGRESQL_PORT=5432;
7171
PRODUCTION_MODE=false;
72-
JWT_PRIVATE_KEY={use generated key here}
72+
JWT_PRIVATE_KEY={use generated key here};
7373
```
7474

7575
JSON format
@@ -83,9 +83,24 @@ JSON format
8383
"JWT_PRIVATE_KEY": "USE GENERATED KEY HERE"
8484
```
8585

86-
8786
Set these variables to build configuration.
8887

88+
Add the following ENVs in order to have pre-created local admin user and access token.
89+
90+
ENV format
91+
```INI
92+
APIHUB_ADMIN_EMAIL=<admin_login, example: apihub>;
93+
APIHUB_ADMIN_PASSWORD=<admin_password, example: password>;
94+
APIHUB_ACCESS_TOKEN=<put_your_key_here - any random string>;
95+
```
96+
97+
JSON format
98+
```JSON
99+
"APIHUB_ADMIN_EMAIL": "admin_login, example: apihub"
100+
"APIHUB_ADMIN_PASSWORD": "admin_password, example: password"
101+
"APIHUB_ACCESS_TOKEN": "put_your_key_here - any random string"
102+
```
103+
89104
#### Run API hub
90105

91106
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.

docs/newcomer_env_setup.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# Applications to install fo newcomer GO developer
22

3-
## 1) Install Git (Git Bash) from software center.
3+
## 1) Install Git.
44
Then ask access to GIT repositories listed in Backend sources section of the [Onboarding](onboarding.md) document.
55

66
## 2) Install and setup Podman Desktop or Rancher Desktop (your choice).

docs/onboarding.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1 +1,5 @@
1-
TODO
1+
UNDER CONSTRUCTION
2+
3+
# Repositories list
4+
5+
todo

0 commit comments

Comments
 (0)