Commit 7529f0a5 authored by Florian Bruggisser's avatar Florian Bruggisser
Browse files

added readme with new naming convention

parent 48e9e677
# Telemersion Server # Telemersive Router
Telemersion Server that contains an MQTT broker and the telemersion-manager. Telemersive Router that contains an telemersive-broker and the telemersive-manager.
## Installation ## Installation
To install the telemersion server on an instance clone the github repository into the installation directory (for example `/opt/telemersion-server`). To install the telemersive router on an instance clone the github repository into the installation directory (for example `/opt/telemersive-router`).
``` ```
git clone https://gitlab.zhdk.ch/iaspace/05_projects/telemersion-server git clone https://gitlab.zhdk.ch/iaspace/05_projects/telemersive-router
``` ```
### Mosquitto Broker Service Important for the installation is that
### Broker
To install the mosquitto broker as a service (Debian with systemd) use the following command: To install the mosquitto broker as a service (Debian with systemd) use the following command:
```bash ```bash
sudo ./broker-service-install.sh sudo ./broker-service-install.sh
``` ```
### Manager Service ### Manager
tdb
Installs the manager together with NPM if it is not installed already.
```bash
sudo ./manager-service-install.sh
```
## Configuration
### Broker
#### Change Credentials
```bash
cd broker
```
Edit the `users.pwd`:
```
manager:password
peer:password
```
To encryp the passwords, run the following script:
```bash
./encrypt-userlist.sh
```
## Update
To update please first stop the service to not break the running service and later start it again.
### Manager
To update to a newer version change to the manager directory and update the npm project:
```bash
cd manager
npm install
```
## Usage ## Usage
### Mosquitto Broker ### Broker
To test the mosquitto broker it is possible to run it without service installation: To test the mosquitto broker it is possible to run it without service installation:
...@@ -33,31 +76,69 @@ To test the mosquitto broker it is possible to run it without service installati ...@@ -33,31 +76,69 @@ To test the mosquitto broker it is possible to run it without service installati
```bash ```bash
# start service # start service
sudo systemctl start telemersion-broker.service sudo systemctl start telemersive-broker.service
# stop service # stop service
sudo systemctl stop telemersion-broker.service sudo systemctl stop telemersive-broker.service
# restart service # restart service
sudo systemctl restart telemersion-broker.service sudo systemctl restart telemersive-broker.service
# enable service (auto-start on restart) # enable service (auto-start on restart)
sudo systemctl enable telemersion-broker.service sudo systemctl enable telemersive-broker.service
# disbale service # disbale service
sudo systemctl disable telemersion-broker.service sudo systemctl disable telemersive-broker.service
# show status # show status
sudo systemctl status telemersion-broker.service sudo systemctl status telemersive-broker.service
``` ```
### Manager ### Manager
tbd
To run the manager without the service use the following script:
```bash
./manager-run.sh
```
#### Service
```bash
# start service
sudo systemctl start telemersive-manager.service
# stop service
sudo systemctl stop telemersive-manager.service
# restart service
sudo systemctl restart telemersive-manager.service
# enable service (auto-start on restart)
sudo systemctl enable telemersive-manager.service
# disbale service
sudo systemctl disable telemersive-manager.service
# show status
sudo systemctl status telemersive-manager.service
```
## Uninstall ## Uninstall
### Mosquitto Broker ### Broker
```bash ```bash
sudo ./broker-service-uninstall.sh sudo ./broker-service-uninstall.sh
``` ```
\ No newline at end of file
### Manager
```bash
sudo ./manager-service-uninstall.sh.sh
```
## Credits
- Florian Bruggisser
- Martin Fröhlich
\ No newline at end of file
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment