#2627 adding documentation. updated order of pages, corrected typos #49
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Frooodle
requested changes
Jan 7, 2025
| # Using an External Database | ||
|
|
||
| It is possible to use your own external database with Stirling PDF rather than the default H2 database if you wish. | ||
| PostgreSQL is currently supported with others soon to follow. |
There was a problem hiding this comment.
Others added on request not 'soon'
| name: postgres | ||
| ``` | ||
|
|
||
| - `enableCustomDatabase`: Set this property to `true` to enable use of the custom database |
There was a problem hiding this comment.
Add note that they need enterprise license to use external DB feature
| - `name`: The name of the custom database. This should match the name you have set for your database | ||
|
|
||
| ### Docker Based Configuration | ||
| You can also configure an external database within using Docker. |
There was a problem hiding this comment.
I think rather than doing a This or That approach with settings.yml and docker it might be better to use a tabbed function
here is a example
593e33d
https://docs.stirlingpdf.com/Advanced%20Configuration/UI%20Customisation
| ``` | ||
|
|
||
| - `depends_on`: This specifies any services that your app will need in order to run. Ensure the name matches the container name for your database | ||
| - `DOCKER_ENABLE_SECURITY`: Set this to `true` to enable security features (required for external database configuration) |
There was a problem hiding this comment.
You mention this for the docker section but not the yaml section, perhaps a general section before these is needed to say you need security and enterprise etc?
| POSTGRES_PASSWORD: "stirling" | ||
| ``` | ||
|
|
||
| *Example configuration can be found in `/exampleYmlFiles/docker-compose-latest-fat-security-postgres.yml`* |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Documentation for External Database support (#2270)