Skip to content

Commit

Permalink
Docs cosmetics
Browse files Browse the repository at this point in the history
  • Loading branch information
alagishev committed Jan 14, 2025
1 parent 1593b30 commit 4d3101e
Show file tree
Hide file tree
Showing 3 changed files with 23 additions and 4 deletions.
19 changes: 17 additions & 2 deletions docs/local_development/local_development.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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=<admin_login, example: apihub>;
APIHUB_ADMIN_PASSWORD=<admin_password, example: password>;
APIHUB_ACCESS_TOKEN=<put_your_key_here - any random string>;
```

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.
Expand Down
2 changes: 1 addition & 1 deletion docs/newcomer_env_setup.md
Original file line number Diff line number Diff line change
@@ -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).
Expand Down
6 changes: 5 additions & 1 deletion docs/onboarding.md
Original file line number Diff line number Diff line change
@@ -1 +1,5 @@
TODO
UNDER CONSTRUCTION

# Repositories list

todo

0 comments on commit 4d3101e

Please sign in to comment.