@@ -14,14 +14,18 @@ First, feel free to modify the server configuration by editing the following fil
-`config/server/nexus.conf`
Next, the `PREFIX` environment variable must be set to the root directory where nexus-server will be installed. Within that directory, a `nexus-server` directory will be created.
Next, the `PREFIX` environment variable must be set to the root directory where nexus-server will be installed. Within that directory, a `nexus-server` directory will be created. Here, we set `PREFIX` to the home directory of the current user. This means nexus-server will be installed into `$HOME/nexus-server`.
In the example below, we set `PREFIX` to the home directory of the current user. This means nexus-server will be installed into `$HOME/nexus-server`.
```
export PREFIX=$HOME
````
If bash is your system shell, you can add the `export` line above to the `.bashrc` file in your home directory. This way, whenever you open a new terminal, the `PREFIX` variable will be set.
Run the following commands to build and install nexus-server:
Then, run the following commands to build and install nexus-server for development:
```
make build_srv
make install_dev_srv PREFIX=$HOME
make install_dev_srv
```
## Running nexus-server (dev)
...
...
@@ -32,35 +36,31 @@ make run_srv PREFIX=$HOME
## Updating nexus-server binaries (dev)
Stop nexus-server by pressing CTRL-C in the terminal it was started, then run:
During development, the server code is constantly modified. To build, update and run the server after a change, simply stop nexus-server by pressing CTRL-C and run:
```
make build_srv update_srv PREFIX=$HOME
make build_srv update_srv run_srv
```
## Uninstalling nexus-server (dev)
```
make uninstall_prod_srv PREFIX=$HOME
make uninstall_prod_srv
```
# Installing nexus-server for production
## Building and installing nexus-server (prod)
Start by modifying the following two files which will be used to create the certificates:
1. Modify `config/certs/ca.info` to your liking
1. Modify `config/certs/nexus-server.info` to your liking
Next, feel free to modify the server configuration by editing the following file:
First, feel free to modify the server configuration by editing the following file:
- `config/server/nexus.conf`
Then, the `PREFIX` environment variable must be set to the root directory where nexus-server will be installed. Within that directory, a `nexus-server` directory will be created.
Then, modify these files which are used to generate the certificates:
In the example below, we set `PREFIX` to `/usr/local`. This means nexus-server will be installed into `/usr/local/nexus-server`.
1. `config/certs/ca.info`
1. `config/certs/nexus-server.info`
Run the following commands to build and install nexus-server:
Next, run the following to build and install nexus-server. Note that the `PREFIX` environment variable must be set to the root directory where nexus-server will be installed. Within that directory, a `nexus-server` directory will be created. Below, we set `PREFIX` to `/usr/local`. This means nexus-server will be installed into `/usr/local/nexus-server`:
```
make build_srv
sudo -E make install_prod_srv PREFIX=/usr/local
...
...
@@ -68,10 +68,19 @@ sudo -E make install_prod_srv PREFIX=/usr/local
## Running nexus-server (prod)
The installation script creates a systemd service named "nexus-server". It can then be started like any other systemd service with:
```
sudo systemctl start nexus-server
```
Furthermore, typical systemd service commands can be used, for instance:
- `sudo systemctl status nexus-server` to check whether the service is running
- `sudo systemctl stop nexus-server` to stop the service
- `sudo systemctl enable nexus-server` to enable the service at boot time
- `sudo systemctl disable nexus-server` to disable the service at boot time
## Updating nexus-server binaries (prod)
```
...
...
@@ -95,7 +104,8 @@ sudo -E make uninstall_prod_srv PREFIX=/usr/local
If nexus-server was installed for a development environment, then run the following (to match `PREFIX` that was defined previously for dev):
```
make build_nexush PREFIX=$HOME
export PREFIX=$HOME
make build_nexush
```
## Building nexush for production (prod)
...
...
@@ -126,7 +136,7 @@ make run_nexus-exam PREFIX=$HOME
# Running validation tests
A variety of tests can be performed in the hope to locate potentiel bugs in the code.
A variety of tests can be performed to locate potentiel bugs in the code.
These tests expect a template that includes "xubuntu" in its name, otherwise it will spill out errors.
Furthermore, make sure the login you specify below has access to this template and has most capabilities enabled.
