Various enhancements/fixes
- Use mxisd for directory names and not mxis (typo) - Better self-install instructions
This commit is contained in:
31
README.md
31
README.md
@@ -64,9 +64,9 @@ cd mxisd
|
|||||||
4. Edit an entity in your LDAP database and set the configure attribute with a Matrix ID (e.g. `@john.doe:example.org`)
|
4. Edit an entity in your LDAP database and set the configure attribute with a Matrix ID (e.g. `@john.doe:example.org`)
|
||||||
|
|
||||||
## Test build and configuration
|
## Test build and configuration
|
||||||
Start the server in foreground:
|
Start the server in foreground to validate the build:
|
||||||
```
|
```
|
||||||
./gradlew bootRun
|
./build/libs/mxisd.jar
|
||||||
```
|
```
|
||||||
|
|
||||||
Ensure the signing key is available:
|
Ensure the signing key is available:
|
||||||
@@ -91,21 +91,28 @@ After [building](#build) the software, run all the following commands as `root`
|
|||||||
# Create a dedicated user
|
# Create a dedicated user
|
||||||
useradd -r mxisd
|
useradd -r mxisd
|
||||||
|
|
||||||
# Create config directory
|
# Create bin directory
|
||||||
mkdir /etc/mxis
|
mkdir /opt/mxisd
|
||||||
|
|
||||||
# Change user ownership of /etc/mxis to dedicated user
|
# Create config directory and set ownership
|
||||||
chown mxisd /etc/mxis
|
mkdir /etc/mxisd
|
||||||
|
chown mxisd /etc/mxisd
|
||||||
|
|
||||||
# Copy <repo root>/build/libs/mxisd.jar to /usr/bin/mxisd
|
# Create data directory and set ownership
|
||||||
cp ./build/libs/mxisd.jar /usr/bin/mxisd
|
mkdir /var/opt/mxisd
|
||||||
|
chown mxisd /var/opt/mxisd
|
||||||
|
|
||||||
# Make it executable
|
# Copy <repo root>/build/libs/mxisd.jar to bin directory
|
||||||
chmod a+x /usr/bin/mxisd
|
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 (or create a new) `./application.yaml` to `/etc/mxis/mxisd.yaml`
|
2. Copy the config file created earlier `./application.yaml` to `/etc/mxisd/mxisd.yaml`
|
||||||
3. Configure `/etc/mxis/mxisd.yaml` with production value, `key.path` being the most important - `/etc/mxis/mxisd-signing.key` is recommended
|
3. Configure `/etc/mxisd/mxisd.yaml` with production value, `key.path` being the most important - `/var/opt/mxisd/signing.key` is recommended
|
||||||
4. Copy `<repo root>/src/main/systemd/mxisd.service` to `/etc/systemd/system/` and edit if needed
|
4. Copy `<repo root>/src/main/systemd/mxisd.service` to `/etc/systemd/system/` and edit if needed
|
||||||
5. Manage service for auto-startup
|
5. Manage service for auto-startup
|
||||||
```
|
```
|
||||||
|
@@ -4,7 +4,7 @@ After=syslog.target
|
|||||||
|
|
||||||
[Service]
|
[Service]
|
||||||
User=mxisd
|
User=mxisd
|
||||||
ExecStart=/usr/bin/mxisd --spring.config.location=/etc/mxis/ --spring.config.name=mxisd
|
ExecStart=/usr/bin/mxisd --spring.config.location=/etc/mxisd/ --spring.config.name=mxisd
|
||||||
SuccessExitStatus=143
|
SuccessExitStatus=143
|
||||||
|
|
||||||
[Install]
|
[Install]
|
||||||
|
Reference in New Issue
Block a user