Skip to content

Commit

Permalink
fix(docs): autogenerate docs (#4050)
Browse files Browse the repository at this point in the history 
* docs: auto-generated property docs

* docs: auto-generated Swagger SPEC docs

* docs: generate and add javadocs
  • Loading branch information
@mo-auto
mo-auto committed Mar 9, 2023
1 parent 8bb6275 commit dcbb645
Show file tree
Hide file tree
Showing 2,305 changed files with 770,882 additions and 181 deletions.
42 changes: 24 additions & 18 deletions docs/admin/install/docker-install/compose.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -24,23 +24,29 @@ Docker monolith image packaging for Janssen. This image packs janssen services i

Installation depends on the set of environment variables shown below. These environment variables can be set to customize installation as per the need. If not set, the installer uses default values.

| ENV | Description | Default |
|-------------------------|--------------------------------------------------|--------------------------------------------------|
| `CN_HOSTNAME` | Hostname to install janssen with. | `demoexample.jans.io` |
| `CN_ADMIN_PASS` | Password of the admin user. | `1t5Fin3#security` |
| `CN_ORG_NAME` | Organization name. Used for ssl cert generation. | `Janssen` |
| `CN_EMAIL` | Email. Used for ssl cert generation. | `support@jans.io` |
| `CN_CITY` | City. Used for ssl cert generation. | `Austin` |
| `CN_STATE` | State. Used for ssl cert generation | `TX` |
| `CN_COUNTRY` | Country. Used for ssl cert generation. | `US` |
| `CN_INSTALL_LDAP` | **NOT SUPPORRTED YET** | `false` |
| `CN_INSTALL_CONFIG_API` | Installs the Config API service. | `true` |
| `CN_INSTALL_SCIM` | Installs the SCIM API service. | `true` |
| `CN_INSTALL_FIDO2` | Installs the FIDO2 API service. | `true` |
| `MYSQL_DATABASE` | MySQL jans database. | `jans` |
| `MYSQL_USER` | MySQL database user. | `jans` |
| `MYSQL_PASSWORD` | MySQL database user password. | `1t5Fin3#security` |
| `MYSQL_HOST` | MySQL host. | `mysql` which is the docker compose service name |
| ENV | Description | Default |
|----------------------------|----------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------------------------------------------|
| `CN_HOSTNAME` | Hostname to install janssen with. | `demoexample.jans.io` |
| `CN_ADMIN_PASS` | Password of the admin user. | `1t5Fin3#security` |
| `CN_ORG_NAME` | Organization name. Used for ssl cert generation. | `Janssen` |
| `CN_EMAIL` | Email. Used for ssl cert generation. | `support@jans.io` |
| `CN_CITY` | City. Used for ssl cert generation. | `Austin` |
| `CN_STATE` | State. Used for ssl cert generation | `TX` |
| `CN_COUNTRY` | Country. Used for ssl cert generation. | `US` |
| `CN_INSTALL_LDAP` | **NOT SUPPORRTED YET** | `false` |
| `CN_INSTALL_MYSQL` | Install jans with mysql as the backend | `false` |
| `CN_INSTALL_PGSQL` | Install jans with Postgres as the backend | `false` |
| `CN_INSTALL_CONFIG_API` | Installs the Config API service. | `true` |
| `CN_INSTALL_SCIM` | Installs the SCIM API service. | `true` |
| `CN_INSTALL_FIDO2` | Installs the FIDO2 API service. | `true` |
| `RDBMS_DATABASE` | RDBMS jans database for MySQL or Postgres. | `jans` |
| `RDBMS_USER` | RDBMS database user for MySQL or Postgres. | `jans` |
| `RDBMS_PASSWORD` | RDBMS database user password for MySQL or Postgres. | `1t5Fin3#security` |
| `RDBMS_HOST` | RDBMS host for MySQL or Postgres. | `mysql` which is the docker compose service name |
| `TEST_CLIENT_ID` | ID of test client in UUID which has all available scopes to access any jans API | `9876baac-de39-4c23-8a78-674b59df8c09` |
| `TEST_CLIENT_SECRET` | Secret for test client | `1t5Fin3#security` |
| `TEST_CLIENT_TRUSTED` | Trust test client | `true` |
| `TEST_CLIENT_REDIRECT_URI` | **Not Implemented yet** Redirect URI for test client. Multiple uri's with comma may be provided, if not provided redirect uris will be same as the config-api-client | `` |


## How to run
Expand All @@ -49,7 +55,7 @@ Download the compose file

```bash

wget https://raw.githubusercontent.com/JanssenProject/jans/vreplace-janssen-version/docker-jans-monolith/jans-mysql-compose.yml
wget https://raw.githubusercontent.com/JanssenProject/jans/main/docker-jans-monolith/jans-mysql-compose.yml
```

This docker compose file runs two containers, the janssen monolith container and mysql container.
Expand Down
Loading

0 comments on commit dcbb645

Please sign in to comment.