LOGS installation steps (Linux)
Checklist
These steps must be done before installing LOGS:
Decide on a group name
LOGS is a multi-tenant application, you can run several groups on the same server that are strictly isolated from each other. You need to decide how many groups you need (typically only one) and what the name of your group should be. Only alphanumeric characters, underscores and hyphens are allowed. The name of the group is part of the URL under which you'll reach your LOGS server, e.g.:
https://logs.mydomain.com/groupname
Get a LOGS license
You need a license file to install LOGS. The license file is specific to a LOGS group, so you need to provide your chosen group name to Sciy support to receive a license file. Once you have the license file, copy it to the server on which you want to install LOGS
Get TLS certificates
TLS Certificates are necessary to enable HTTPS access to any web application like LOGS. If your LOGS is intended to be publicly reachable from the internet you can get free certificates from Let's Encrypt. You can do this at the same time as installing LOGS.
If your LOGS is internal and only reachable inside your VPN or intranet, you need to ask your IT department to provide certificates. This should be done well in advance of the actual LOGS installation.
You need a full chain certificate file and a private key file, both in PEM format.
1. Download the installation script
Execute the following command in your Linux shell and follow the instructions:
sudo curl -Ls https://install.logs-sciy.com | bash
Enter the passphrase you were given here to decrypt the actual installation script.
2. Run the installation script
Make sure your license file is in the same folder as the installation script you just downloaded.
Run the installation script with the command:
sudo bash ./install_logs_ubuntu24_alma.sh current
It will ask you for the install location, leave it at the default /opt/logs.
3. Set up TLS certificates
Transfer the TLS certificates to the LOGS server, this manual will assume they are in the folder /opt/logs/certs. Open the main LOGS config file (/opt/logs/logs-config.toml) as root and add the lines for CertificatePath and KeyPath inside the [Server] section:
[Server]
HttpPort = 80
HttpsPort = 443
ListenAddress = "0.0.0.0"
AllowHttp = false
CertificatePath = "/opt/logs/certs/fullchain.pem"
KeyPath = "/opt/logs/certs/privkey.pem"
Now restart LOGS with the command
sudo systemctl restart logs-core-engine
3B. Disable HTTPS
This option is strongly discouraged for production LOGS servers. It disables HTTPS entirely, so all communication between the LOGS server and the users as well as the instruments is not encrypted. It is intended for test environments where no certificate can be easily arranged.
Open the main LOGS config file (/opt/logs/logs-config.toml) as root and set the AllowHttp option to true
[Server]
HttpPort = 80
HttpsPort = 443
ListenAddress = "0.0.0.0"
AllowHttp = true
Now restart LOGS with the command
sudo systemctl restart logs-core-engine
4. Add your first admin user
You need to create one admin user to set up your initial LOGS and create additional users. You can do that using the LOGS command line tool "create-user". Run the following command with your correct values for the group, login and email parameters in the LOGS installation folder (/opt/logs):
./LOGS create-user --group nmr --login admin --email [email protected] --last-name Doe --role "global administrator"
The CLI tool will then ask you to enter a password for that user.
5. Log into the LOGS web interface
Navigate to the domain of your LOGS server using your web browser. Select the correct group in the UI and then log in with the user and password you defined in the previous step.
Now you can finish setting up the rest of LOGS, create additional users and connect instruments.
