Skip to content

Commit

Permalink
feat: update server-core configuration (env,file,..) description
Browse files Browse the repository at this point in the history
  • Loading branch information
tada5hi committed Feb 26, 2024
1 parent b781d36 commit 42033b0
Show file tree
Hide file tree
Showing 2 changed files with 29 additions and 23 deletions.
44 changes: 25 additions & 19 deletions src/guide/deployment/configuration-server-core.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,30 +43,34 @@ export default {
* Admin user name.
* Default: 'admin'
*/
adminUsername: 'admin',
userAdminName: 'admin',
/**
* Admin password.
* Default: 'start123'
*/
adminPassword: 'start123',
userAdminPassword: 'start123',
/**
* Reset the admin password if it has already
* been created with a different password.
*/
adminPasswordReset: false,
userAdminPasswordReset: false,
/**
* Enable a global robot account.
*/
robotEnabled: false,
robotAdminEnabled: false,
/**
* Robot password/secret.
* Robot admin name
*/
robotSecret: 'foo',
robotAdminName: 'system',
/**
* Robot admin password/secret.
*/
robotAdminSecret: 'foo',
/**
* Reset the robot secret if it has already
* been created with a different password.
*/
robotSecretReset: false
robotAdminSecretReset: false
}
```

Expand All @@ -77,12 +81,13 @@ authorizeRedirectUrl=http://localhost:3000
registration=false
emailVerification=false
forgotPassword=false
adminUsername=admin
adminPassword=start123
adminPasswordReset=false
robotEnabled=false
robotSecret=foo
robotSecretReset=false
userAdminName=admin
userAdminPassword=start123
userAdminPasswordReset=false
robotAdminEnabled=false
robotAdminName=system
robotAdminSecret=foo
robotAdminSecretReset=false
```

Expand All @@ -93,12 +98,13 @@ AUTHORIZE_REDIRECT_URL=http://localhost:3000
REGISTRATION=false
EMAIL_VERIFICATION=false
FORGOT_PASSWORD=false
ADMIN_USERNAME=admin
ADMIN_PASSWORD=start123
ADMIN_PASSWORD_RESET=false
ROBOT_ENABLED=false
ROBOT_SECRET=foo
ROBOT_SECRET_RESET=false
USER_ADMIN_NAME=admin
USER_ADMIN_PASSWORD=start123
USER_ADMIN_PASSWORD_RESET=false
ROBOT_ADMIN_ENABLED=false
ROBOT_ADMIN_NAME=system
ROBOT_ADMIN_SECRET=foo
ROBOT_ADMIN_SECRET_RESET=false
```
:::
8 changes: 4 additions & 4 deletions src/guide/deployment/docker-compose.md
Original file line number Diff line number Diff line change
Expand Up @@ -114,8 +114,8 @@ services:
ports:
- "3001:3000"
environment:
- ADMIN_USERNAME=test
- ADMIN_PASSWORD=test-password
- USER_ADMIN_NAME=test
- USER_ADMIN_PASSWORD=test-password
command: server/core start
```
Expand All @@ -129,8 +129,8 @@ Create a file called `authup.server.core.conf` and store it in the same director
the file which will configure the admin user for the API service:

```dotenv
ADMIN_USERNAME=test
ADMIN_PASSWORD=test-password
USER_ADMIN_NAME=test
USER_ADMIN_PASSWORD=test-password
```

In the following compose file example you can see that the
Expand Down

0 comments on commit 42033b0

Please sign in to comment.