The KNOX pipeline runs on six Ubuntu servers. To access the servers, you must either be on AAU's network or be using the AAU VPN, and have permissions from ITS. Read the Server Distribution spreadsheet for a detailed overview of what services are running on the following servers.
In a future iteration of KNOX, the information in the Server Distribution spreadsheet should be written in tables here on the KNOX Wiki instead.
knox-preproc01.srv.aau.dk
knox-func01.srv.aau.dk
knox-kb01.srv.aau.dk
knox-db01.srv.aau.dk
knox-proxy01.srv.aau.dk
knox-web01.srv.aau.dk
knox-front01.srv.aau.dk
You can access the servers from the command line using the following command:
ssh <STUDENT_MAIL>@<SERVER_NAME> -L <your_port>:localhost:<host_port>
This establishes an SSH tunnel to the server and creates a port tunnel from the server to a local port.
The server knox-preproc01.srv.aau.dk
contains the following services:
The server knox-func01.srv.aau.dk
contains the following services:
The server knox-kb01.srv.aau.dk
contains the following services:
The server knox-db01.srv.aau.dk
contains the following services:
The server knox-proxy01.srv.aau.dk
contains the following services:
The server knox-web01.srv.aau.dk
contains the following services:
The server knox-front01.srv.aau.dk
contains the following services:
Shared .secrets file is stored on knox-func01.srv.aau.dk
. Run the following commands to view the secrets (use Ctrl + x to close the file):
ssh <your-aau-mail@student.aau.dk>@knox-func01.srv.aau.dk
cd srv/data/credentials
nano .secrets
Use sudo
to edit the file (use Ctrl + s to save the file):
sudo nano .secrets
Remember to write a comment about which service uses the env variable.
Docker is an open-source project for automating the deployment of applications as portable, self-sufficient containers that can run on the cloud or on-premises.
The advantages it provides us:
The setup of Docker is straight forward by just copying the commands from: https://docs.docker.com/engine/install/ubuntu/ (UBUNTU)
Wiki.js is setup using a docker-compose file that is placed on the knox-web01
server, this file contains the complete setup of wiki.js and the postgreSQL database that it uses.
Any changes that on the wiki or postgresql database will need to be done in this docker-compose file.
These are the current environment variables for the database:
DB_TYPE: postgres
DB_HOST: db
DB_PORT: 5432
DB_USER: wiki
DB_PASS: <CENSORED>
DB_NAME: wiki
If changes are needed to the docker-compose file then after changing the files, runnning docker compose down
while in the directory of the docker-compose file would close down both containers. And then running docker compose build
to force docker to rebuild the image from the new configuration, and after that is done run docker compose up --detach
to start the containers again detached.
The database is setup using a postgresql alpine image without any custom setup.