From 2a337532f4bcc2f289a7b400739c1cbeacf9db4a Mon Sep 17 00:00:00 2001 From: Zachary Klosko Date: Wed, 20 May 2020 09:25:37 -0400 Subject: [PATCH 01/10] Fixing copyright, organization as per @robbt --- docs/_data/navigation.yml | 4 ++-- docs/_layouts/default.html | 1 - docs/contribute.md | 5 ++++- 3 files changed, 6 insertions(+), 4 deletions(-) diff --git a/docs/_data/navigation.yml b/docs/_data/navigation.yml index 087612bbc..e0cbceb5c 100644 --- a/docs/_data/navigation.yml +++ b/docs/_data/navigation.yml @@ -32,6 +32,8 @@ sidebar: url: live-broadcast - page: Adding Users url: users + - page: Help! + url: troubleshooting subsubfolderitems: - page: More Tutorials url: tutorials @@ -43,8 +45,6 @@ sidebar: - page: - title: Appendix subfolderitems: - - page: Help! - url: troubleshooting - page: HD Audio Modules url: hd-audio-modules - page: Rights and Royalties diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html index 28c942e86..9a14acddb 100644 --- a/docs/_layouts/default.html +++ b/docs/_layouts/default.html @@ -95,7 +95,6 @@ diff --git a/docs/contribute.md b/docs/contribute.md index f4d3ced24..c23253fc2 100644 --- a/docs/contribute.md +++ b/docs/contribute.md @@ -21,7 +21,7 @@ Have an idea that would make LibreTime even better than it is right now? Start a LibreTime can run in over 15 different languages due to the gracious help of our volunteers. Is your language not supported? Follow [this guide](interface-localization) to add your language to LibreTime! -## Help build and text LibreTime +## Help write code for LibreTime Are you familar with coding in PHP? Have you made projects in Liquidsoap and some of the other services we use? Take a look at the bugs and feature requests [here](https://github.com/LibreTime/libretime/issues), and then @@ -30,9 +30,12 @@ your desktop, open up a favorite editor and make some changes, and then commit, Knowledge on how to use [Github](https://guides.github.com/activities/hello-world/) and [Git](https://git-scm.com/docs/gittutorial) will suit you well, use the links for a quick 101. +### Testing LibreTime in Vagrant + Before submitting code to the project, it's a good idea to test it first. To do this, it's easiest to install LibreTime in a virtural machine on your local system or in a cloud VM. Instructions on how to set up a virtural instance of LibreTime with Vagrant are located [here](vagrant). + If you would like to try LibreTime in a Docker image, Odclive has instructions [here](https://github.com/kessibi/libretime-docker) for setting up a test image and a more persistant install. From b73179b5e4be950c02487cd36d6d86afd78e786c Mon Sep 17 00:00:00 2001 From: Zachary Klosko Date: Wed, 20 May 2020 09:33:03 -0400 Subject: [PATCH 02/10] Removing Docker info Docker isn't the best candidate for a LibreTime installation --- docs/contribute.md | 4 ---- 1 file changed, 4 deletions(-) diff --git a/docs/contribute.md b/docs/contribute.md index c23253fc2..bfec65db2 100644 --- a/docs/contribute.md +++ b/docs/contribute.md @@ -36,10 +36,6 @@ Before submitting code to the project, it's a good idea to test it first. To do LibreTime in a virtural machine on your local system or in a cloud VM. Instructions on how to set up a virtural instance of LibreTime with Vagrant are located [here](vagrant). -If you would like to try LibreTime in a Docker image, -Odclive has instructions [here](https://github.com/kessibi/libretime-docker) for setting up a test image -and a more persistant install. - ### Modifying the Database LibreTime is designed to work with a [PostgreSQL](https://www.postgresql.org/) database server running locally. LibreTime uses [PropelORM](http://propelorm.org) to interact with the ZendPHP components and create the database. From 44a57b308d5f02a97c5b1fa4a47c497fb6bd604c Mon Sep 17 00:00:00 2001 From: Zachary Klosko Date: Wed, 20 May 2020 10:15:49 -0400 Subject: [PATCH 03/10] Removing PPA info, not working --- docs/quickstart.md | 8 -------- 1 file changed, 8 deletions(-) diff --git a/docs/quickstart.md b/docs/quickstart.md index 11b6384e4..187d5e0f6 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -73,20 +73,12 @@ sudo ufw enable 8002/tcp Installing LibreTime consists of running the following commands in the terminal: -Option 1: ``` git clone https://github.com/LibreTime/libretime.git cd libretime sudo ./install -fiap ``` -Option 2: -``` -sudo add-apt-repository ppa:libretime/libretime -sudo apt-get update -sudo apt-get install libretime icecast2 -``` - After the install is completed, head to the IP address of the server LibreTime was just installed on to complete the welcome wizard. While not strictly necessary, it is recommended that you change the passwords prompted in the welcome wizard if you intend on accessing the server from the Internet. The welcome wizard will walk you through the rest of the installation process. From 709ed02ad0df2afca80808b2467a5976a5ececbb Mon Sep 17 00:00:00 2001 From: Zachary Klosko Date: Wed, 20 May 2020 10:53:14 -0400 Subject: [PATCH 04/10] Fixing verbage --- docs/quickstart.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/quickstart.md b/docs/quickstart.md index 187d5e0f6..7058a48e2 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -60,7 +60,7 @@ sudo ufw allow 80/tcp sudo ufw allow 8000/tcp ``` -If you plan on broadcasting live with Libretime, also unblock ports 8001 and 8002. +Unblock ports 8001 and 8002 if you plan on broadcasting live with Libretime. ``` sudo ufw enable 8001/tcp From b873a4330a0e71ff9ba29a807b0361fc3f56fa26 Mon Sep 17 00:00:00 2001 From: Zachary Klosko Date: Wed, 20 May 2020 10:59:51 -0400 Subject: [PATCH 05/10] Adding docs from #473 to Quick Install page --- docs/quickstart.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/quickstart.md b/docs/quickstart.md index 7058a48e2..e86d81e3a 100644 --- a/docs/quickstart.md +++ b/docs/quickstart.md @@ -85,7 +85,14 @@ walk you through the rest of the installation process. Congratulations! You've successfully set up LibreTime! -## Next Steps +## Post-install + +If you plan to have LibreTime output analog audio directly from its server to a mixing console or transmitter, +the `www-data` user needs to be added to the `audio` user group using the command below. + +``` +sudo adduser www-data audio +``` Now that the install is complete, use these guides to help you continue to set up your LibreTime server From 981e5d600cbb18e3e79ccba9e769de4eb2ecd0ff Mon Sep 17 00:00:00 2001 From: Zachary Klosko Date: Wed, 20 May 2020 09:33:03 -0400 Subject: [PATCH 06/10] Revert "Removing Docker info" This reverts commit b73179b5e4be950c02487cd36d6d86afd78e786c. --- docs/contribute.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/contribute.md b/docs/contribute.md index bfec65db2..c23253fc2 100644 --- a/docs/contribute.md +++ b/docs/contribute.md @@ -36,6 +36,10 @@ Before submitting code to the project, it's a good idea to test it first. To do LibreTime in a virtural machine on your local system or in a cloud VM. Instructions on how to set up a virtural instance of LibreTime with Vagrant are located [here](vagrant). +If you would like to try LibreTime in a Docker image, +Odclive has instructions [here](https://github.com/kessibi/libretime-docker) for setting up a test image +and a more persistant install. + ### Modifying the Database LibreTime is designed to work with a [PostgreSQL](https://www.postgresql.org/) database server running locally. LibreTime uses [PropelORM](http://propelorm.org) to interact with the ZendPHP components and create the database. From ef480eb9c94eef94ff71dc2ca01a33b3edb07176 Mon Sep 17 00:00:00 2001 From: Zachary Klosko Date: Wed, 20 May 2020 12:15:09 -0400 Subject: [PATCH 07/10] Fixing bad FAQ link in LT interface --- airtime_mvc/application/configs/constants.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/airtime_mvc/application/configs/constants.php b/airtime_mvc/application/configs/constants.php index 30901efb0..a88e1f8ed 100644 --- a/airtime_mvc/application/configs/constants.php +++ b/airtime_mvc/application/configs/constants.php @@ -15,7 +15,7 @@ define('SUPPORT_ADDRESS' , 'https://discourse.libretime.org/'); define("AIRTIMEPRO_API_URL", "https://account.example.com:5001/api/"); define('HELP_URL' , 'https://discourse.libretime.org/'); -define('FAQ_URL' , 'http://libretime.org/faq/'); +define('FAQ_URL' , 'http://libretime.org/faq'); define('WHOS_USING_URL' , 'https://github.com/orgs/LibreTime/people'); define('TERMS_AND_CONDITIONS_URL' , 'https://github.com/LibreTime/libretime/blob/master/README.md'); define('PRIVACY_POLICY_URL' , 'https://github.com/LibreTime/code-of-conduct/blob/master/CODE_OF_CONDUCT.md'); From ff9f78b0f83d0658a9e88ac526e06b44c71eeccd Mon Sep 17 00:00:00 2001 From: Zachary Klosko Date: Wed, 20 May 2020 12:18:10 -0400 Subject: [PATCH 08/10] Fixing broken USER_MANUAL_URL --- airtime_mvc/application/configs/constants.php | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/airtime_mvc/application/configs/constants.php b/airtime_mvc/application/configs/constants.php index a88e1f8ed..38232fb20 100644 --- a/airtime_mvc/application/configs/constants.php +++ b/airtime_mvc/application/configs/constants.php @@ -19,7 +19,7 @@ define('FAQ_URL' , 'http://libretime.org/faq'); define('WHOS_USING_URL' , 'https://github.com/orgs/LibreTime/people'); define('TERMS_AND_CONDITIONS_URL' , 'https://github.com/LibreTime/libretime/blob/master/README.md'); define('PRIVACY_POLICY_URL' , 'https://github.com/LibreTime/code-of-conduct/blob/master/CODE_OF_CONDUCT.md'); -define('USER_MANUAL_URL' , 'http://libretime.org/manual/'); +define('USER_MANUAL_URL' , 'http://libretime.org/'); define('ABOUT_AIRTIME_URL' , 'http://libretime.org'); define('AIRTIME_TRANSIFEX_URL' , 'http://libretime.org/translating/'); define('LIBRETIME_DISCOURSE_URL' , 'https://discourse.libretime.org'); From a50b7dbe21e3d1e2035a1ed41d4cdc160d0e3868 Mon Sep 17 00:00:00 2001 From: Zachary Klosko Date: Wed, 20 May 2020 12:25:22 -0400 Subject: [PATCH 09/10] Converting "Help translate..." to "Contribute to LibreTime" --- airtime_mvc/application/configs/constants.php | 2 +- airtime_mvc/application/configs/navigation.php | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/airtime_mvc/application/configs/constants.php b/airtime_mvc/application/configs/constants.php index 38232fb20..fb854d113 100644 --- a/airtime_mvc/application/configs/constants.php +++ b/airtime_mvc/application/configs/constants.php @@ -21,7 +21,7 @@ define('TERMS_AND_CONDITIONS_URL' , 'https://github.com/LibreTime/libretime/bl define('PRIVACY_POLICY_URL' , 'https://github.com/LibreTime/code-of-conduct/blob/master/CODE_OF_CONDUCT.md'); define('USER_MANUAL_URL' , 'http://libretime.org/'); define('ABOUT_AIRTIME_URL' , 'http://libretime.org'); -define('AIRTIME_TRANSIFEX_URL' , 'http://libretime.org/translating/'); +define('LIBRETIME_CONTRIBUTE_URL' , 'https://libretime.org/contribute'); define('LIBRETIME_DISCOURSE_URL' , 'https://discourse.libretime.org'); define('UI_REVAMP_EMBED_URL' , 'https://www.youtube.com/embed/nqpNnCKGluY'); define('LIBRETIME_WHATS_NEW_URL' , 'https://github.com/LibreTime/libretime/releases'); diff --git a/airtime_mvc/application/configs/navigation.php b/airtime_mvc/application/configs/navigation.php index b839958b7..c6acf0c61 100644 --- a/airtime_mvc/application/configs/navigation.php +++ b/airtime_mvc/application/configs/navigation.php @@ -179,8 +179,8 @@ $pages[] = array( 'target' => "_blank" ), array( - 'label' => _('Help Translate Libretime'), - 'uri' => AIRTIME_TRANSIFEX_URL, + 'label' => _('Contribute to LibreTime'), + 'uri' => LIBRETIME_CONTRIBUTE_URL, 'target' => "_blank" ), array( From bf171ac5037a305d099208b9841ca856be58c65e Mon Sep 17 00:00:00 2001 From: Zachary Klosko Date: Thu, 21 May 2020 14:45:15 -0400 Subject: [PATCH 10/10] License info added @robbt --- docs/_layouts/default.html | 1 + 1 file changed, 1 insertion(+) diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html index 9a14acddb..3317ac1d1 100644 --- a/docs/_layouts/default.html +++ b/docs/_layouts/default.html @@ -95,6 +95,7 @@

Hosted on GitHub Pages — Theme by orderedlist + Code and docs licensed under GPLv2. More details here.