Documentation enhancements (#73)
This commit is contained in:
38
docs/install/source.md
Normal file
38
docs/install/source.md
Normal file
@@ -0,0 +1,38 @@
|
||||
# Install from sources
|
||||
## Instructions
|
||||
Follow the [build instructions](../build.md) then:
|
||||
|
||||
1. Prepare files and directories:
|
||||
```bash
|
||||
# Create a dedicated user
|
||||
useradd -r mxisd
|
||||
|
||||
# Create bin directory
|
||||
mkdir /opt/mxisd
|
||||
|
||||
# Create config directory and set ownership
|
||||
mkdir -p /etc/opt/mxisd
|
||||
chown -R mxisd /etc/opt/mxisd
|
||||
|
||||
# Create data directory and set ownership
|
||||
mkdir -p /var/opt/mxisd
|
||||
chown -R mxisd /var/opt/mxisd
|
||||
|
||||
# Copy <repo root>/build/libs/mxisd.jar to bin directory
|
||||
cp ./build/libs/mxisd.jar /opt/mxisd/
|
||||
chown mxisd /opt/mxisd/mxisd.jar
|
||||
chmod a+x /opt/mxisd/mxisd.jar
|
||||
|
||||
# Create symlink for easy exec
|
||||
ln -s /opt/mxisd/mxisd.jar /usr/bin/mxisd
|
||||
```
|
||||
2. Copy the sample config file `./application.example.yaml` to `/etc/opt/mxisd/mxisd.yaml`, edit to your needs
|
||||
3. Copy `src/systemd/mxisd.service` to `/etc/systemd/system/` and edit if needed
|
||||
4. Enable service for auto-startup
|
||||
```bash
|
||||
systemctl enable mxisd
|
||||
```
|
||||
5. Start mxisd
|
||||
```bash
|
||||
systemctl start mxisd
|
||||
```
|
Reference in New Issue
Block a user