sintonia/docs/admin-manual/setup/install.md
Jonas L 3ec85d7821
docs: update structure and create links between pages (#1611)
* docs: rework files structure

* rewrite documentation entrypoint

* update category files and use yml

* add manuals entry page

* update admin-manual titles and page order

* create releases sections

* move ssl configuration to reverse proxy

* docs: update website vars and links

* update release note codeblock syntax key

* resurect troubleshooting guide

* Update freeipa custom auth documentation

* add notice about the state of the documentation

* update the backup documentation

* tmp: allow to deploy the website for preview

* Don't use require.resolve for plugins

* Update the main page link dest

* update development environment title

* rewrite the install/upgrade/migrate as guides

* update website docs sections links

* Fix urls

* move release note to documentation

* move home links to vars files

* tmp: update deploy url

* add react to tsconfig to handle jsx linting

* fix: replace absolute url to relative path to files

* tmp: allow CI Website dpeloy on working branch

* Update release note title

* use default syntax highlighting theme

* update the troubleshooting guide

* Wording

* use CodeBlock components

* Better prose

* remove api_client config section

* fix prose errors

* update import prefix for vars file

* reroder docs manuals links

* use sentence capitalization for page titles

* Wording

* missing word

* Update note about syslog log file

* wording
2022-02-21 09:16:54 +02:00

3.8 KiB

title sidebar_position
Install 10

import Tabs from '@theme/Tabs'; import TabItem from '@theme/TabItem'; import CodeBlock from '@theme/CodeBlock'; import vars from '@site/vars';

This guide walk you though the steps required to install LibreTime on your system.

:::tip

If you are coming from Airtime, please follow the Airtime migration guide.

:::

You can install LibreTime using the one of the following methods:

Minimum system requirements

Using the installer

The installer is shipped in the released tarballs or directly in the project repository.

Download

You can either download the latest released tarball or clone the repository.

Download the latest released tarball from Github.

Or directly from the command-line:

wget https://github.com/libretime/libretime/releases/download/{vars.version}/libretime-{vars.version}.tar.gz

And extract the tarball:

tar -xvf libretime-{vars.version}.tar.gz && cd libretime

Clone the project repository:

git clone https://github.com/libretime/libretime
cd libretime

And checkout the latest version:

git checkout {vars.version}

Run the installer

Install LibreTime with the recommended options:

sudo ./install -fiap

Additional options can be listed with the following command:

./install --help

Once the installation is completed, open http://localhost:80 to complete the setup wizard.

:::note

  • If installed on a remote device, make sure to replace localhost with your server's remote address.
  • If installed with a custom port, make sure to replace 80 with the custom port.

:::

:::warning

Make sure that you have configured a firewall and it's not blocking connection to the desired ports.

LibreTime requires the following ports to be open:

  • 80 for the web interface,
  • 8000 for the Icecast streams,
  • 8001 and 8002 for the live stream input endpoint.

Consider putting your installation behind a reverse proxy to increase the security.

:::

Using hardware audio output

If you plan to output analog audio directly to a mixing console or transmitter, the user running LibreTime (by default www-data) needs to be added to the audio user group using the command below:

sudo adduser www-data audio

Setup wizard

The setup wizard walk you through the rest of the installation process.

Changing default passwords

It's recommended that you change the passwords prompted in the setup wizard. Be sure to apply the changes on the server before going to any next step.

You can change the default PostgreSQL user password using:

sudo -u postgres psql -c "ALTER USER airtime PASSWORD 'new-password';"

You can change the default RabbitMQ user password using:

sudo rabbitmqctl change_password "airtime" "new-password"

Once completed, it's recommended to install a reverse proxy to setup SSL termination and secure your installation.