Add documentation for updating the config file

Fixes: #918
This commit is contained in:
Kyle Robbertze 2020-01-08 14:10:01 +02:00
parent 5cfa57234b
commit 559c63f933
2 changed files with 22 additions and 46 deletions

View file

@ -42,18 +42,13 @@ You can also set options for RabbitMQ messaging, the LibreTime server and SoundC
[demo] [demo]
demo = 0 demo = 0
Save and close the file with **Ctrl+O** and **Ctrl+X**. If you have changed the database settings, you should now run the command: Save and close the file with **Ctrl+O** and **Ctrl+X**. In order to update the configuration
used by the various components of LibreTime, run the following commands
sudo airtime-update-db-settings
to make sure all of LibreTime's database configuration files are updated. This command should output the following text to the server console:
LibreTime root folder found at /usr/share/airtime
Updating /usr/share/airtime/application/configs/application.ini
Updating /usr/share/airtime/build/build.properties
Updating /usr/share/airtime/build/runtime-conf.xml
Success!
sudo systemctl restart airtime-liquidsoap
sudo systemctl restart airtime-playout
sudo systemctl restart airtime-celery
sudo systemctl restart airtime_analyzer
API client configuration API client configuration
------------------------ ------------------------
@ -73,7 +68,7 @@ Playout and recorder settings
Settings for pypo, the playout and recording engine used by LibreTime, are found in the file */etc/airtime/airtime.conf*. After making changes to this file, you will have to issue the command: Settings for pypo, the playout and recording engine used by LibreTime, are found in the file */etc/airtime/airtime.conf*. After making changes to this file, you will have to issue the command:
sudo /etc/init.d/airtime-playout restart sudo systemctl restart airtime-playout
for the changes to take effect. for the changes to take effect.
@ -145,17 +140,3 @@ for the changes to take effect.
# while 'otf' (on the fly) cues while loading into ls # while 'otf' (on the fly) cues while loading into ls
# (needs the post_processor patch) # (needs the post_processor patch)
cue_style = pre cue_style = pre
############################################
# Recorded Audio settings #
############################################
record_bitrate = 256
record_samplerate = 44100
record_channels = 2
record_sample_size = 16
#can be either ogg|mp3, mp3 recording requires installation of the package "lame"
record_file_type = ogg
# base path to store recorded shows at
base_recorded_files = /var/tmp/airtime/show-recorder/

View file

@ -1,25 +1,20 @@
If your Airtime server is not working as expected, individual components of the system can be started, stopped, restarted or checked in the server console using the <span style="font-weight: bold;">invok</span>**e-rc.d** command: If your Airtime server is not working as expected, individual components of the system can be started, stopped, restarted or checked in the server console using the **systemctl** command:
sudo invoke-rc.d airtime-liquidsoap start|stop|restart|status sudo systemctl start|stop|restart|status airtime-liquidsoap
sudo invoke-rc.d airtime-playout start|stop|restart|status sudo systemctl start|stop|restart|status airtime-playout
sudo invoke-rc.d airtime-analyzer start|stop|restart|status sudo systemctl start|stop|restart|status airtime-celery
sudo invoke-rc.d apache2 start|stop|restart|status sudo systemctl start|stop|restart|status airtime_analyzer
sudo invoke-rc.d rabbitmq-server start|stop|restart|status sudo systemctl start|stop|restart|status apache2
sudo systemctl start|stop|restart|status rabbitmq-server
For example, to restart the Airtime playout engine, you could enter the command: For example, to restart the Airtime playout engine, you could enter the command:
sudo invoke-rc.d airtime-playout restart sudo systemctl restart airtime-analyzer
The server should respond:
Restarting Airtime Playout: Done.
The **status** option for **airtime-playout** and **airtime-analyzer** runs the **airtime-check-system** script to confirm that all of Airtime's dependencies are installed and running correctly.
Log files Log files
--------- ---------
Airtime stores log files under the directory path */var/log/airtime/* which can be useful for diagnosing the cause of any problems. Copies of these log files may be requested by Sourcefabric engineers while they are providing technical support for your Airtime deployment. See the chapter *The airtime-log command* for more details. Airtime stores log files under the directory path */var/log/airtime/* which can be useful for diagnosing the cause of any problems. Copies of these log files may be requested by LibreTime developers while they are providing technical support for your Airtime deployment.
Test tones Test tones
---------- ----------
@ -72,7 +67,7 @@ where the hostname is *airtime.example.com*. If the hostname has changed, it may
2. Restart RabbitMQ: 2. Restart RabbitMQ:
sudo invoke-rc.d rabbitmq-server restart sudo systemctl restart rabbitmq-server
3. Enter the following commands to set up authentication and grant permissions. The *rabbitmqctl add\_user* command requires the RabbitMQ password from the /etc/airtime/airtime.conf file as an argument. The *rabbitmqctl set\_permissions* command should be entered on one line, with the list of Airtime services repeated three times: 3. Enter the following commands to set up authentication and grant permissions. The *rabbitmqctl add\_user* command requires the RabbitMQ password from the /etc/airtime/airtime.conf file as an argument. The *rabbitmqctl set\_permissions* command should be entered on one line, with the list of Airtime services repeated three times: