diff --git a/docs/_config.yml b/docs/_config.yml index c1b0a9a73..d638e5c0e 100644 --- a/docs/_config.yml +++ b/docs/_config.yml @@ -15,6 +15,6 @@ navigation: - text: FAQ url: faq - text: Manual - url: tutorials + url: manual - text: Help! url: troubleshooting \ No newline at end of file diff --git a/docs/_layouts/default.html b/docs/_layouts/default.html index 85e175250..8a9baa8a8 100644 --- a/docs/_layouts/default.html +++ b/docs/_layouts/default.html @@ -38,17 +38,6 @@ {% endif %} - {% for link in site.navigation %} - {% assign current = nil %} - {% if page.url == link.url %} - {% assign current = 'current' %} - {% endif %} - -
  • - {{ link.text }} -
    • - {% endfor %} -
    diff --git a/docs/tutorials.md b/docs/manual.md similarity index 86% rename from docs/tutorials.md rename to docs/manual.md index 674c194bc..b2a3d2f5b 100644 --- a/docs/tutorials.md +++ b/docs/manual.md @@ -36,6 +36,7 @@ There are also a number of tutorials in Spanish on [Vimeo](https://vimeo.com/use * [How to livestream with butt](tuts/livestream) * [How to do a live show with MIXXX](tuts/live-shows-with-mixxx/index) * [How to prepare media for ingest to LibreTime](tuts/preparing-media-for-ingest/index) +* [Smartphone journalism](tuts/smartphone-journalism/index) ## For Program Managers * [Building a schedule](tuts/build-schedule) @@ -56,11 +57,13 @@ There are also a number of tutorials in Spanish on [Vimeo](https://vimeo.com/use ### Advanced Configuration * [Installing LibreTime from Git on a stand-alone VPS](tuts/install-vps) +* [Configuring FreeIPA authentication](tuts/freeipa) +* [Embedding a streaming player on your website](tuts/embed-player/index) * [Securing icecast and customizing stream settings ](tuts/stream-settings) +* [Using Icecast and Shoutcast in the studio](tuts/icecast-and-shoutcast/index) * [How to install player and calendar widgets on your website](tuts/widgets) * [Configuring track types](tuts/track-types) * [Interface Customization](tuts/interface-customization/index) -* [Localization Settings](tuts/interface-localization/index) * [Setting up SSL](tuts/secure-login-with-ssl) * [Promoting your station through your Icecast stream](tuts/promoting-your-station) * [Configuring Icecast handover](tuts/icecast-handover/index) @@ -69,7 +72,13 @@ There are also a number of tutorials in Spanish on [Vimeo](https://vimeo.com/use * [Upgrading LibreTime](tuts/upgrading/index) * [Uninstalling LibreTime](tuts/uninstall) +## For Developers and Contributors +* [Setting up a LibreTime instance with Vagrant](vagrant) +* [Database access](database) +* [Translating LibreTime](tuts/interface-localization/index) + ## Appendix * [About this manual](tuts/about-manual) * [HD Audio Module information](tuts/hd-audio-modules) * [Rights and royalty information](tuts/rights-royalties) +* [Information on media folders used by LibreTime](tuts/folders) diff --git a/docs/manual/convert.sh b/docs/manual/convert.sh deleted file mode 100755 index 6171c010b..000000000 --- a/docs/manual/convert.sh +++ /dev/null @@ -1,16 +0,0 @@ -#!/bin/bash - -book="booktype-25" -base_path=`pwd` -pandoc_cmd="docker run --rm -ti -v ${base_path}:${base_path} jagregory/pandoc" - -for html in `find ${book} -name 'index.html'`; do - pushd `dirname $html` - mkdir -p ${base_path}/`dirname ${html#*/}` - $pandoc_cmd -o - -f html -t markdown_github ${base_path}/${html} > `echo "${base_path}/${html#*/}" | sed 's/html$/md/'` - popd -done - -for static in `find ${book} -name 'static'`; do - cp -rp ${static} ${static#*/} -done diff --git a/docs/manual/media-folders/static/Screenshot194-Drop_files_into_organize.png b/docs/manual/media-folders/static/Screenshot194-Drop_files_into_organize.png deleted file mode 100644 index 3f6949007..000000000 Binary files a/docs/manual/media-folders/static/Screenshot194-Drop_files_into_organize.png and /dev/null differ diff --git a/docs/manual/media-folders/static/Screenshot195-Midnite_Vultures-File_Browser.png b/docs/manual/media-folders/static/Screenshot195-Midnite_Vultures-File_Browser.png deleted file mode 100644 index 1230587e5..000000000 Binary files a/docs/manual/media-folders/static/Screenshot195-Midnite_Vultures-File_Browser.png and /dev/null differ diff --git a/docs/manual/media-folders/static/Screenshot227-Choose_storage_folder.png b/docs/manual/media-folders/static/Screenshot227-Choose_storage_folder.png deleted file mode 100644 index 889ee476e..000000000 Binary files a/docs/manual/media-folders/static/Screenshot227-Choose_storage_folder.png and /dev/null differ diff --git a/docs/manual/media-folders/static/Screenshot228-Import_folder_changed_1.png b/docs/manual/media-folders/static/Screenshot228-Import_folder_changed_1.png deleted file mode 100644 index 00b0a18ae..000000000 Binary files a/docs/manual/media-folders/static/Screenshot228-Import_folder_changed_1.png and /dev/null differ diff --git a/docs/manual/media-folders/static/Screenshot229-Storage_change_warning_1.png b/docs/manual/media-folders/static/Screenshot229-Storage_change_warning_1.png deleted file mode 100644 index 7730222fa..000000000 Binary files a/docs/manual/media-folders/static/Screenshot229-Storage_change_warning_1.png and /dev/null differ diff --git a/docs/manual/media-folders/static/Screenshot230-Add_watched_folder_1.png b/docs/manual/media-folders/static/Screenshot230-Add_watched_folder_1.png deleted file mode 100644 index f14571918..000000000 Binary files a/docs/manual/media-folders/static/Screenshot230-Add_watched_folder_1.png and /dev/null differ diff --git a/docs/manual/media-folders/static/Screenshot301-Change_storage_folder.png b/docs/manual/media-folders/static/Screenshot301-Change_storage_folder.png deleted file mode 100644 index 997ddb3bb..000000000 Binary files a/docs/manual/media-folders/static/Screenshot301-Change_storage_folder.png and /dev/null differ diff --git a/docs/manual/media-folders/static/Screenshot302-Sure_remove_watched_folder.png b/docs/manual/media-folders/static/Screenshot302-Sure_remove_watched_folder.png deleted file mode 100644 index c97e2e49a..000000000 Binary files a/docs/manual/media-folders/static/Screenshot302-Sure_remove_watched_folder.png and /dev/null differ diff --git a/docs/manual/media-folders/static/Screenshot399-Manage_media_folders.png b/docs/manual/media-folders/static/Screenshot399-Manage_media_folders.png deleted file mode 100644 index 79fe7a199..000000000 Binary files a/docs/manual/media-folders/static/Screenshot399-Manage_media_folders.png and /dev/null differ diff --git a/docs/manual/recording-shows/index.md b/docs/manual/recording-shows/index.md deleted file mode 100644 index e3ba66fde..000000000 --- a/docs/manual/recording-shows/index.md +++ /dev/null @@ -1,33 +0,0 @@ -Live show recording from the input of the server's sound card, if one is fitted, can be enabled in the **Add Show** box of Airtime's **Calendar** (see the *Calendar* chapter for details). During a recording, a red light is shown in the Master Panel, and the word **Recording** appears in a red font to the left of the show name. - -![](static/Screenshot362-Recording_light.png) - -Before the first broadcast show scheduled for recording begins, you should check that the level of recording is sufficient to ensure a good signal to noise ratio, but not so high a level that clipping (distortion) occurs in the recorded file. You can perform this check using the command **alsamixer** on the Airtime server. This command opens a soundcard mixer application in the server console. - -![](static/Screenshot274-Line_in_level.png) - -Press the **F4** key on your keyboard to set capture levels. Some experimentation may be required to find the correct control on the mixer, using the **Left** and **Right** arrow keys on your keyboard. Levels are set with the **Up** and **Down** arrows, and *Capture* is toggled with the **Space** bar. *Capture dB gain* should be set to *0.00, 0.00* initially. - -If you hear nothing at all in the recording, you may need to set the value of *Input Source* to *Line*, using the **Up** or **Down** arrows. Depending on the particular sound card and sockets you are using, you may have to enable other inputs, such as *Digital* or *S/PDIF*. If a test recording is too quiet, try raising the line output level of your broadcast mixer towards *0dB* before increasing gain above *0dB* on the sound card, in order to achieve the optimal gain structure. - -Using recordings ----------------- - -After the recording has finished, you can find the recorded file in the **Library**, by searching for *recorder*. The file will be labelled with a **Title** containing a date and time stamp, as well as the name of the show. - -![](static/Screenshot461-Airtime_show_recorder.png) - -Click a file and select **Edit Metadata** from the pop-up menu to enter additional details of the recording which will help you find it in searches later, such as **Album** or **Language**. Then click the **Save** button. - -![](static/Screenshot462-Edit_recording_metadata.png) - -Cancelling a recording ----------------------- - -If you wish to cancel the recording of a live show, click on the show in the **Calendar** and select **Cancel Current Show** from the pop-up menu. - -![](static/Screenshot363-Cancel_current_show.png) - -Airtime will ask you if you are sure about this action, as it cannot be undone. The recorded show file in the Airtime library will be truncated if you click the **OK** button. - -![](static/Screenshot361-Stop_recording_show.png) diff --git a/docs/manual/recording-shows/static/Screenshot274-Line_in_level.png b/docs/manual/recording-shows/static/Screenshot274-Line_in_level.png deleted file mode 100644 index 08ae67ad8..000000000 Binary files a/docs/manual/recording-shows/static/Screenshot274-Line_in_level.png and /dev/null differ diff --git a/docs/manual/recording-shows/static/Screenshot361-Stop_recording_show.png b/docs/manual/recording-shows/static/Screenshot361-Stop_recording_show.png deleted file mode 100644 index 67968b4f4..000000000 Binary files a/docs/manual/recording-shows/static/Screenshot361-Stop_recording_show.png and /dev/null differ diff --git a/docs/manual/recording-shows/static/Screenshot362-Recording_light.png b/docs/manual/recording-shows/static/Screenshot362-Recording_light.png deleted file mode 100644 index e3b83b102..000000000 Binary files a/docs/manual/recording-shows/static/Screenshot362-Recording_light.png and /dev/null differ diff --git a/docs/manual/recording-shows/static/Screenshot363-Cancel_current_show.png b/docs/manual/recording-shows/static/Screenshot363-Cancel_current_show.png deleted file mode 100644 index 6855085cb..000000000 Binary files a/docs/manual/recording-shows/static/Screenshot363-Cancel_current_show.png and /dev/null differ diff --git a/docs/manual/recording-shows/static/Screenshot461-Airtime_show_recorder.png b/docs/manual/recording-shows/static/Screenshot461-Airtime_show_recorder.png deleted file mode 100644 index 7f5c78c06..000000000 Binary files a/docs/manual/recording-shows/static/Screenshot461-Airtime_show_recorder.png and /dev/null differ diff --git a/docs/manual/recording-shows/static/Screenshot462-Edit_recording_metadata.png b/docs/manual/recording-shows/static/Screenshot462-Edit_recording_metadata.png deleted file mode 100644 index be1ae2d38..000000000 Binary files a/docs/manual/recording-shows/static/Screenshot462-Edit_recording_metadata.png and /dev/null differ diff --git a/docs/manual/using-the-airtime-import-script/index.md b/docs/manual/using-the-airtime-import-script/index.md deleted file mode 100644 index 00199419b..000000000 --- a/docs/manual/using-the-airtime-import-script/index.md +++ /dev/null @@ -1,88 +0,0 @@ -Using the import script -======================= - -###NOTE: This page has issues, as the import script is not currently functional - - -If you have a large number of files in your media library, importing these files one at a time into a broadcast automation system would be time-consuming and tedious. That's why Airtime includes a script that can import an entire directory of files in one go. - -Copying versus watching ------------------------ - -There are three main options when using the **airtime-import** script: Either to **copy** or **move** files into Airtime's main storage folder, or to **watch** files elsewhere. Each option has advantages and disadvantages, so you will have to think about how the files will be used in your station in the long term. - -- For files that are *copied* or *moved*, you may run into problems with hard disk space if you do not remove files from the storage server periodically. -- For files that are watched, you must make sure that the files are actually going to be there at playout time, otherwise they will be skipped. For this reason, it is not recommended to use the **watch** option for easily-removable storage (like MP3 players or USB memory sticks). There's a strong likelihood that the storage might be unplugged and taken away before playout time. It is also important to make sure that any external hard disk with watched files is powered on, and stays on. - -The **airtime-import** script works from the command line, so you must first log into a console on the Airtime server. In recent versions of Airtime, you no longer need to specify the full file system path to the media files that you wish to import. Copying is specified with the **copy** sub-command: - - airtime-import --copy - -where *<directory>* is the base directory of the media files that you wish to import. - -Alternatively, you may wish to delete the files from the original location after copying them to the storage archive, which is accomplished with the **move** sub-command: - - airtime-import --move - -If the new files are exact duplicates of files that have already been imported, the **airtime-import** script will detect this. - -Any users logged into the administration interface will be warned if a **File import** is **in progress**... Users assigned the *admin* privilege should not attempt to change Airtime's default storage directory while an import is taking place. - -![](static/Screenshot463-File_import_in_progress.png) - -Watching a new folder on the command line is specified by using the **watch add** sub-command: - - airtime-import --watch-add - -The script will report the name of the folder now being watched, for example: - - airtime-import --watch-add /home/Music/ - /home/Music/ added to watched folder list successfully - -The watched folder will also be listed on the **Media Folders** page on the **System** menu of the Airtime administration interface. (See the chapter *Media Folders* for making changes to watched folders via the administration interface). - -To obtain a list of currently watched folders in the server console, you can use the **watch list** sub-command: - - airtime-import --watch-list - /home/Music/ - -Any new files copied to a watched folder (for example, using your desktop computer's file manager) will automatically appear in the Airtime database, and are then ready for playout. In the same way, if you delete a media file using your file manager, it will be automatically removed from the Airtime database, and will no longer be available for playout. - -If you wish to no longer watch a particular folder, you can use the **watch remove** sub-command: - - airtime-import --watch-remove /home/Music/ - /home/Music/ removed from watched folder list successfully  - -Get or set the storage folder path ----------------------------------- - -See the chapter *Media Folders* for making changes to the storage folder path via the administration interface. The **airtime-import** script also enables you to read or write Airtime's storage path configuration. You can find out the current setting with the **storage-dir get** sub-command: - - airtime-import --storage-dir-get - /srv/airtime/stor - -A new storage folder path can be configured using the **storage-dir set** sub-command: - - airtime-import --storage-dir-set /home/Music/ - Successfully set storage folder to /home/Music/ - -The **storage-dir set** sub-command should be used with caution on a production server, because moving the storage folder during scheduled programming has the potential to disrupt your broadcast playout. The Airtime playout engine caches files up to 24 hours ahead, but any last-minute additions to the schedule during storage migration could cause problems. - - There has been error in communication with Booktype server. Not sure right now where is the problem. - -You should refresh this page. - -- OK -- Back -- Create -- Cancel -- Next -- Import -- Save changes -- Couldn't create a group! -- enter epub URL -- enter Archive.org ID -- enter Wikibooks URL -- enter Booktype URL -- Delete book - diff --git a/docs/manual/using-the-airtime-import-script/static/Screenshot463-File_import_in_progress.png b/docs/manual/using-the-airtime-import-script/static/Screenshot463-File_import_in_progress.png deleted file mode 100644 index f7f5e3610..000000000 Binary files a/docs/manual/using-the-airtime-import-script/static/Screenshot463-File_import_in_progress.png and /dev/null differ diff --git a/docs/testing.md b/docs/testing.md deleted file mode 100644 index 1708b5eb3..000000000 --- a/docs/testing.md +++ /dev/null @@ -1,74 +0,0 @@ -# Testing LibreTime - -## MVC - -The MVC tests are based on PHPUnit and may be found in `airtime_mvc/tests`. - -You can run the tests in you working copy as described below or let travis -run them for you on pushes. - -### Prepare environment - -PHPUnit will need to be able to access the database and be allowed to -create the libretime_test database. On a clean postgresql install this may -be set up as follows. - -```bash -psql -c 'CREATE DATABASE libretime;' -U postgres -psql -c "CREATE USER libretime WITH PASSWORD 'libretime';" -U postgres -psql -c 'GRANT CONNECT ON DATABASE libretime TO libretime;' -U postgres -psql -c 'ALTER USER libretime CREATEDB;' -U postgres -``` - -In this case the libretime database is only used for the initial connection -over which the libretime_test database is created. - -You may need to tweak the exact commands needed to setup postgresql depending -on the distro you installed this to. On Ubuntu the above can be acheived as -follows. - -```bash -sudo -u postgres psql -c 'CREATE DATABASE libretime;' -sudo -u postgres psql -c "CREATE USER libretime WITH PASSWORD 'libretime';" -sudo -u postgres psql -c 'GRANT CONNECT ON DATABASE libretime TO libretime;' -sudo -u postgres psql -c 'ALTER USER libretime CREATEDB;' -``` - -### Install PHPUnit - -PHPUnit should have already been installed when you ran `composer install`. - -If you have not done so, now is the time to do so. - -### Run the tests - -```bash -# run all tests -cd airtime_mvc/tests -../../vendor/bin/phpunit - -# run a subset of tests -../../vendor/bin/phpunit --filter testEditReatingShowInstance -``` - -## Python - -The python tests are run through nosetest. To prepare your env you should install -it. - -```bash -# Debian/Ubuntu -apt-get install python-nose - -# CentOS -yum install -y python-nose -``` - -In most cases you need to install deps before the tests can be run. - -### Airtime Analyzer - -```bash -cd python_apps/airtime_analyzer -nosetests -``` diff --git a/docs/translating.md b/docs/translating.md deleted file mode 100644 index 83e65063d..000000000 --- a/docs/translating.md +++ /dev/null @@ -1,4 +0,0 @@ -While LibreTime is translatable software, it does not yet have a translation interface. - -Please [let us know](https://github.com/LibreTime/libretime/issues/new) if you want -to contribute to the translation effort so we can prioritize setting such an interface. diff --git a/docs/manual/stream-player-for-your-website/index.md b/docs/tuts/embed-player/index.md similarity index 100% rename from docs/manual/stream-player-for-your-website/index.md rename to docs/tuts/embed-player/index.md diff --git a/docs/manual/stream-player-for-your-website/static/Screenshot525-jplayer-demo_240.png b/docs/tuts/embed-player/static/Screenshot525-jplayer-demo_240.png similarity index 100% rename from docs/manual/stream-player-for-your-website/static/Screenshot525-jplayer-demo_240.png rename to docs/tuts/embed-player/static/Screenshot525-jplayer-demo_240.png diff --git a/docs/manual/media-folders/index.md b/docs/tuts/folders.md similarity index 100% rename from docs/manual/media-folders/index.md rename to docs/tuts/folders.md diff --git a/docs/freeipa.md b/docs/tuts/freeipa.md similarity index 100% rename from docs/freeipa.md rename to docs/tuts/freeipa.md diff --git a/docs/manual/icecast-and-shoutcast/index.md b/docs/tuts/icecast-and-shoutcast/index.md similarity index 100% rename from docs/manual/icecast-and-shoutcast/index.md rename to docs/tuts/icecast-and-shoutcast/index.md diff --git a/docs/manual/icecast-and-shoutcast/static/Screenshot223-Icecast_UTF-8_metadata.png b/docs/tuts/icecast-and-shoutcast/static/Screenshot223-Icecast_UTF-8_metadata.png similarity index 100% rename from docs/manual/icecast-and-shoutcast/static/Screenshot223-Icecast_UTF-8_metadata.png rename to docs/tuts/icecast-and-shoutcast/static/Screenshot223-Icecast_UTF-8_metadata.png diff --git a/docs/manual/smartphone-journalism/index.md b/docs/tuts/smartphone-journalism/index.md similarity index 100% rename from docs/manual/smartphone-journalism/index.md rename to docs/tuts/smartphone-journalism/index.md diff --git a/docs/manual/smartphone-journalism/static/Image376-Choosing_a_recording_app.png b/docs/tuts/smartphone-journalism/static/Image376-Choosing_a_recording_app.png similarity index 100% rename from docs/manual/smartphone-journalism/static/Image376-Choosing_a_recording_app.png rename to docs/tuts/smartphone-journalism/static/Image376-Choosing_a_recording_app.png diff --git a/docs/manual/smartphone-journalism/static/Image377-Recording_a_file.png b/docs/tuts/smartphone-journalism/static/Image377-Recording_a_file.png similarity index 100% rename from docs/manual/smartphone-journalism/static/Image377-Recording_a_file.png rename to docs/tuts/smartphone-journalism/static/Image377-Recording_a_file.png diff --git a/docs/manual/smartphone-journalism/static/Image378-Select_music_track.png b/docs/tuts/smartphone-journalism/static/Image378-Select_music_track.png similarity index 100% rename from docs/manual/smartphone-journalism/static/Image378-Select_music_track.png rename to docs/tuts/smartphone-journalism/static/Image378-Select_music_track.png diff --git a/docs/manual/smartphone-journalism/static/Image379-Selecting_a_file.png b/docs/tuts/smartphone-journalism/static/Image379-Selecting_a_file.png similarity index 100% rename from docs/manual/smartphone-journalism/static/Image379-Selecting_a_file.png rename to docs/tuts/smartphone-journalism/static/Image379-Selecting_a_file.png diff --git a/docs/manual/smartphone-journalism/static/Image380-Uploading_a_file.png b/docs/tuts/smartphone-journalism/static/Image380-Uploading_a_file.png similarity index 100% rename from docs/manual/smartphone-journalism/static/Image380-Uploading_a_file.png rename to docs/tuts/smartphone-journalism/static/Image380-Uploading_a_file.png