MALIO-DEV/PlantUmlServer
3
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

improve docker handling

Browse Source
This commit is contained in:
Florian
2021-10-11 17:33:30 +02:00
committed by arnaudroques
parent 5190a72cc8
commit 221af78afc
6 changed files with 73 additions and 82 deletions
Download Patch File Download Diff File Expand all files Collapse all files

40
README.md
View File

@@ -57,12 +57,12 @@ This makes the container compatible with more restricted environment such as Ope
## Change base URL
To run plantuml using different base url, change the `docker-compose.yml` file:
~~~
args:
BASE_URL: plantuml
~~~
```yaml
environment:
- BASE_URL=plantuml
```
And run `docker-compose up --build`. This will build a modified version of the image using
And run `docker-compose up`. This will start a modified version of the image using
the base url `/plantuml`, e.g. http://localhost/plantuml
How to set PlantUML options
@@ -86,21 +86,21 @@ docker run -d -p 8080:8080 -e THE_ENV_VARIABLE=THE_ENV_VALUE plantuml/plantuml-s
You can set all the following variables:
* `PLANTUML_LIMIT_SIZE`
* Limits image width and height
* Default value: `4096`
* `GRAPHVIZ_DOT`
* Link to 'dot' executable
* Default value: `/usr/local/bin/dot` or `/usr/bin/dot`
* `PLANTUML_STATS`
* Set it to `on` to enable [statistics report](http://plantuml.com/statistics-report)
* Default value: `off`
* `HTTP_AUTHORIZATION`
* when calling the `proxy` endpoint, the value of `HTTP_AUTHORIZATION` will be used to set the HTTP Authorization header
* Default value: `null`
* `ALLOW_PLANTUML_INCLUDE`
* Enables `!include` processing which can read files from the server into diagrams. Files are read relative to the current working directory.
* Default value: `false`
- `BASE_URL`
* PlantUML base url
* Default value: `ROOT`
- `PLANTUML_LIMIT_SIZE`
* Limits image width and height
* Default value: `4096`
- `PLANTUML_STATS`
* Set it to `on` to enable [statistics report](http://plantuml.com/statistics-report)
* Default value: `off`
- `HTTP_AUTHORIZATION`
* when calling the `proxy` endpoint, the value of `HTTP_AUTHORIZATION` will be used to set the HTTP Authorization header
* Default value: `null`
- `ALLOW_PLANTUML_INCLUDE`
* Enables `!include` processing which can read files from the server into diagrams. Files are read relative to the current working directory.
* Default value: `false`
Alternate: How to build your docker image
======================================================