diff --git a/README.md b/README.md index 01c98b1..1466c6b 100644 --- a/README.md +++ b/README.md @@ -9,9 +9,8 @@ nbscloud requires `java>=18` ### `deploy.sh` ## Config -To adjust the default configuration create the file `~/.config/nbscloud/application.properties`. It allows overwriting -properties from every configuration file of nbscloud. To get a full list of existing properties look at the following -files: +To adjust the default configuration adjust the key-value pairs in the `.env` file. Keep in mind that not all properties +are mentioned in there. To see all available properties click through the available properties files below: |File|Description| |----|-----------| |[application.properties](./web-container/src/main/resources/config/application.properties)|Main config file providing general app properties| diff --git a/examples/.env b/examples/.env new file mode 100644 index 0000000..7a7cb64 --- /dev/null +++ b/examples/.env @@ -0,0 +1,36 @@ +# nbscloud will look for and store files in this directory - mind the permissions +NBSCLOUD_FILES_BASEDIR= + +# Whether dark mode should be used by default +NBSCLOUD_WEBCONTAINER_SHARED_DARKMODE=true + +# Knob to configure whether hidden files are shown +NBSCLOUD_FILES_FILTERHIDDEN=true + +# Whether to use the trash bin or directly removefiles +NBSCLOUD_FILES_USETRASHBIN=true + +# Knob to configure the name of the trash bin directory +NBSCLOUD_FILES_TRASHBINNAME=nbs.internal/nbs.trashbin + +# Knob to configure the amount of character after which the filename +# will be truncated +NBSCLOUD_FILES_TRUNCATEFILENAMECHARS=130 + +# Knob to configure the name of the shares directory +NBSCLOUD_FILES_SHARESNAME=nbs.internal/nbs.shares + +# Knob to configure the name of the app directory +NBSCLOUD_FILES_APPDIR=nbs.internal/apps + +# The address the embedded tomcat listens on - you probably want to keep this on localhost +SERVER_ADDRESS=localhost + +SERVER_SERVLET_CONTEXTPATH=/nbscloud +SERVER_PORT=8082 + +# No upload sze restriction +SPRING_SERVLET_MULTIPART_MAXFILESIZE=-1 +SPRING_SERVLET_MULTIPART_MAXREQUESTSIZE=-1 + +LOGGING_LEVEL_DE_NBSCLOUD=DEBUG \ No newline at end of file diff --git a/examples/docker-compose.yml b/examples/docker-compose.yml new file mode 100644 index 0000000..5f4ad94 --- /dev/null +++ b/examples/docker-compose.yml @@ -0,0 +1,8 @@ +services: + app: + image: your-registry.com/nbscloud:latest + ports: + - "8082:8082" + restart: always + env_file: + - .env \ No newline at end of file