Environment Configuration
LogUI server and Docker require an .env file to be present in the root directory of the LogUI server codebase on your computer. This short Wiki page provides information on all of the settings that can be provided, including an explanation of each variable, and what the default values are.
Note that since this file starts with a
., it may not be visible on macOS or Linux computers by default. From the root directory the command$ ls -ashould show it in a directory listing if you aren't convinced.
This setting tells Docker what port should be exposed on the LogUI server proxy — and subsequently what TCP port on your host system that LogUI is exposed on. The default value provided by create_env is port 8000. Change this value to port 80 for the standard HTTP port. If you don't run LogUI server on port 80, you'll need to specify the port number after the hostname when accessing LogUI server (e.g., hostname:8000). This setting can be safely changed after LogUI server has been initialised.
This setting should provide the hostname of your host system (the computer running Docker). If your hostname is logui.tudelft.nl, that should be the value provided. This tells LogUI server what to expect when requests come in to it.
Note that if you're running LogUI server on macOS, the create_env script may append .local to the end of your hostname. This should be removed.
If you change the hostname of the system after initialising LogUI, you can safely change this variable. It won't cause problems elsewhere.
If you find that LogUI server refuses requests, you may have set this value incorrectly. Check the hostname of your host computer, edit this variable where necessary, and try again. You'll need to stop LogUI server and start it again.
Specifies whether the DEBUG settings should be enabled or not. This shouldn't really be touched unless we ask you for further information when attempting to fix an issue you discover with LogUI server. By default, this should be set to False.
If you need to enable debugging, set this to True. When an error occurs, you will then be able to report back in detail what the problem is. Changing this variable after initialising LogUI server will not cause problems.
The secret key is a pseudo-randomly generated string (50 characters in length) that is used by the cryptography subsystem of LogUI server for encrypting user passwords and authentication tokens. This key is unique to your deployment and should not be shared with anyone else, nor should it be pushed to a public repository. Doing so will comprise the security of your deployment.
If you change this key after starting LogUI server at least once, you will find that user authentication and client authentication will no longer function. This is because salted passwords and generated authentication tokens used by clients to connect to LogUI server will no longer match with the new secret key. Please do not change this key after creating user accounts and linking applications; you'll break things.
This is the password to be used for access to the LogUI server databases. This is used internally by LogUI server; however, if you wish to access the databases yourself (when developing, for example), this is the password you would use.
**Please do not change this key after initialising LogUI server; the databases that were created use the password, and changing the value of DATABASE_PASSWORD will mean LogUI server no longer has access to the databases.
Refer to the First Run Guide for more information on how to create and edit the .env file. Don't touch the .env.example file — this is a standard template that is used to create your own .env file.