diff --git a/docs/install.md b/docs/install.md index d21e4b65e..9896a0cdb 100644 --- a/docs/install.md +++ b/docs/install.md @@ -1,25 +1,75 @@ # Installing LibreTime -There two methods of installing LibreTime - [Source](#source) or -[Ubuntu package](#ubuntu-package). +There two methods of installing LibreTime - [Source (recommended)](#source) or +[Ubuntu package (experimental)](#ubuntu-package). ## Source -LibreTime releases can be downloaded [here](https://github.com/LibreTime/libretime/releases). -Recommendations: +Requirements: -- LibreTime should generally be installed on a dedicated host running Ubuntu 16.04 LTS (Xenial Xerus). -- LibreTime is undergoing active development, and is currently in ALPHA. -- It is not recommended that you install LibreTime on the same computer you are using as a desktop. +- LibreTime should generally be installed on a dedicated host running Ubuntu Server 18.04 LTS, have at least 1 GHz of processor power, at least 2 GB of system RAM, and static IP address. +- LibreTime is undergoing active development, and is currently in ALPHA. Make sure it is working for your needs well before you begin to use it in a live environment. - Please review the release notes of the version you are planning on installing. -Once you have downloaded and extracted LibreTime, run the installation script by navigating into the -folder containing the LibreTime codebase, and run its install script from the command line: +The easiest way to install LibreTime is by cloning the repository using git, and +then running the installer. -``` -sudo ./install -fiap -``` +1. If you don't have git installed already, run `sudo apt install git -y` +2. Create a folder in your home directory for the download and change to it: `cd ~ && mkdir LibreTime && cd LibreTime` +3. Clone the repo: `git clone https://github.com/LibreTime/libretime.git` +4. Run the installer: `sudo ./install -fiap` +5. After the installer is finished, follow the instructions to proceed to the [setup wizard](getting-started/index.md) -The installer will install and configure all dependencies only if the `-fiap` flag is added. If you would prefer to configure dependencies manually, omit the flag. +It's recommended to use the `-fiap` flag to install LibreTime on a fresh server install. This way, +all dependencies will be installed and configured by the installer without needing user input. + +For those who plan to manually configure LibreTime, options for the installer are listed below: +``` +-h, --help, -? + Display usage information +-V, --version + Display version information +-v, --verbose + More output +-q, --quiet, --silent + No output except errors +-f, --force + Turn off interactive prompts +--distribution=DISTRIBUTION + Linux distribution the installation is being run on +--release=RELEASE + Distribution release +-d, --ignore-dependencies + Don't install binary dependencies +-w, --web-user=WEB_USER + Set the apache web user. Defaults to www-data. Only change + this setting if you've changed the default apache web user +-r, --web-root=WEB_ROOT + Set the web root for Airtime files + This will copy the Airtime application files, but you will need + to give your web user access to the given directory if it is + not accessible +--web-port=WEB_PORT + Set what port the LibreTime interface should run on. +-I, --in-place + Set the current Airtime directory as the web root + Note that you will need to give your web user permission to + access this directory if it is not accessible +-p, --postgres + Create a default postgres user named 'airtime' with password + 'airtime' +-a, --apache + Install apache and deploy a basic configuration for Airtime +-i, --icecast + Install Icecast 2 and deploy a basic configuration for Airtime +--selinux + Run restorecon on directories and files that need tagging to + allow the WEB_USER access +--no-postgres + Skips all postgres related install tasks (Useful if you configure + postgresql as part of another script / docker builds) +--no-rabbitmq + Skips all rabbitmq related install tasks. +``` A great tutorial video on how to install LibreTime is [here](https://www.youtube.com/watch?v=Djo_55LgjXE). @@ -40,8 +90,7 @@ sudo apt install icecast2 ./libretime__amd64.deb ## Alternative OS installations Installation in Debian 9 and other Linux distributions is possible, but these -are less tested. Installation on Ubuntu 14.04.5 LTS (Trusty Tahr) is also working, but deprecated due to the -fact that this version will reach its official end of life in April 2019. +are less tested. Plans are in the works for `.rpm` packages, as well as Docker and AWS images. If you would like to try LibreTime in a Docker image, [odclive's (unofficial) image](https://hub.docker.com/r/odclive/libretime-docker) is a great place to start.