diff --git a/doc/EN/app_icecast.org b/doc/EN/app_icecast.org new file mode 100644 index 00000000..15bef337 --- /dev/null +++ b/doc/EN/app_icecast.org @@ -0,0 +1,64 @@ +#+TITLE: +#+AUTHOR: Bob Mottram +#+EMAIL: bob@freedombone.net +#+KEYWORDS: freedombone, icecast +#+DESCRIPTION: How to use Icecast +#+OPTIONS: ^:nil toc:nil +#+HTML_HEAD: + +#+BEGIN_CENTER +[[file:images/logo.png]] +#+END_CENTER + +#+BEGIN_EXPORT html +
+

Icecast

+
+#+END_EXPORT + +Icecast enables you to run something like an internet radio station. So if you have multiple audio files and want to be able to stream those in sequence from a web site then this can be useful. + +This system is available only via an onion address, which should mitigate the potential for copyright disputes over streamed content. By default it's only set up to stream to a small number of users so that it doesn't put too much stress on CPU or memory requirements, although you can increase the maximum limit if you have a more powerful system and enough bandwidth. + +* Installation +Log into your system with: + +#+begin_src bash +ssh myusername@mydomain -p 2222 +#+end_src + +Using cursor keys, space bar and Enter key select *Administrator controls* and type in your password. + +Select *Add/Remove Apps*. If Vim is selected then you might want to unselect and uninstall it first, then select *icecast*. + +If you then go to the *About* screen you'll see the onion address for Icecast and can navigate to it in a Tor compatible browser. + +* Adding files to be streamed +There are two ways to get files onto the system: either via ssh or via a USB drive. File types can be *ogg, ogv, mp3 or mp4* format. + +It may take a while for the files to import, especially on a low power single board computer, since any mp3 or mp4 files will be converted to ogg or ogv. If you want to speed this up then you could do this conversion manually on a laptop with ffmpeg before storing files onto the USB drive or uploading them via ssh. + +** From a USB drive +Create a directory on the USB drive named *icestream* and copy your files into there. Plug the drive into your server. + +Go to the *Administrator control panel*, select *App settings*, then *icecast*, then *Import stream files from USB drive*. + +** Via ssh +Make a directory named *icestream* and copy your files into it. Then copy the directory to your server. + +#+begin_src bash +scp -r -P 2222 icestream myusername@mydomain:/home/myusername +#+end_src + +Log into your server with: + +#+begin_src bash +ssh myusername@mydomain -p 2222 +#+end_src + +Select *Administrator controls*, enter your password, then go to *App settings* followed by *icecast* and *Import stream files*. Choose the directory with up and down cursors and space bar to select. + +* Access controls +By default anyone who happens to find your Icecast onion address can listen to your stream. If you only want it to be available to a few friends or family then you can add an extra login password. + +Go to the *Administrator control panel*, select *App settings*, then *icecast*, then *Enable login for stream users*. Take a note of the password and you can give that out to whoever needs access, preferably via an encrypted chat app or sneakernet. If you need to copy and paste then hold the shift key while highlighting the password. diff --git a/doc/EN/apps.org b/doc/EN/apps.org index 326a3cac..478bbd33 100644 --- a/doc/EN/apps.org +++ b/doc/EN/apps.org @@ -68,6 +68,10 @@ Databaseless blogging system. Quite simple and with a markdown-like format. Web publishing platform with social network like features and good privacy controls so that it's possible to specify who can see which content. Includes photo albums, calendar, wiki and file storage. [[./app_hubzilla.html][How to use it]] +* Icecast media stream +Make your own internet radio station. + +[[./app_icecast.html][How to use it]] * IRC Server (ngirc) Run your own IRC chat channel which can be secured with a password and accessible via an onion address. A bouncer is included so that you can receive messages sent while you were offline. Works with Hexchat and other popular clients. diff --git a/img/mesh_mobileapps.jpg b/img/mesh_mobileapps.jpg index 170eff6c..26688913 100644 Binary files a/img/mesh_mobileapps.jpg and b/img/mesh_mobileapps.jpg differ diff --git a/src/freedombone-app-icecast b/src/freedombone-app-icecast new file mode 100755 index 00000000..8afd10b1 --- /dev/null +++ b/src/freedombone-app-icecast @@ -0,0 +1,765 @@ +#!/bin/bash +# +# .---. . . +# | | | +# |--- .--. .-. .-. .-.| .-. .--.--. |.-. .-. .--. .-. +# | | (.-' (.-' ( | ( )| | | | )( )| | (.-' +# ' ' --' --' -' - -' ' ' -' -' -' ' - --' +# +# Freedom in the Cloud +# +# Icecast application +# +# Notes: An attempt was made to get ices2 running with systemd, but that +# was very unsuccessful. Instead there's a hacky cron entry which +# starts icecast2 and ices2 if necessary +# +# License +# ======= +# +# Copyright (C) 2017 Bob Mottram +# +# This program is free software: you can redistribute it and/or modify +# it under the terms of the GNU Affero General Public License as published by +# the Free Software Foundation, either version 3 of the License, or +# (at your option) any later version. +# +# This program is distributed in the hope that it will be useful, +# but WITHOUT ANY WARRANTY; without even the implied warranty of +# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the +# GNU Affero General Public License for more details. +# +# You should have received a copy of the GNU Affero General Public License +# along with this program. If not, see . + +VARIANTS='full' + +IN_DEFAULT_INSTALL=0 +SHOW_ON_ABOUT=1 +SHOW_ICANN_ADDRESS_ON_ABOUT=0 + +ICECAST_DOMAIN_NAME= +ICECAST_CODE= +ICECAST_PORT=8005 +ICECAST_ONION_PORT=8146 +ICECAST_DIR=/icestream +ICECAST_PLAYLIST_FILE=/etc/ices2/playlist.txt +ICECAST_LOGIN_TEXT=$"Icecast login" + +icecast_variables=(MY_USERNAME + MY_EMAIL_ADDRESS + ONION_ONLY + ICECAST_DOMAIN_NAME + ICECAST_CODE + DEFAULT_LANGUAGE) + +function icecast_rescan { + if [ -d $ICECAST_DIR ]; then + if [ -f $ICECAST_PLAYLIST_FILE ]; then + rm $ICECAST_PLAYLIST_FILE + fi + icecast_add_file_to_playlist $ICECAST_DIR + fi +} + +function icecast_update_daemon { + systemctl stop icecast2 + if [ -f /etc/init.d/icecast2 ]; then + rm /etc/init.d/icecast2 + fi + + echo '#!/bin/sh' > /usr/bin/stop_icecast + echo 'kill $(pidof ices2)' >> /usr/bin/stop_icecast + echo 'systemctl stop icecast2' >> /usr/bin/stop_icecast + chmod +x /usr/bin/stop_icecast + + # Note that the sleep here actually is important + echo '#!/bin/bash' > /usr/bin/start_icecast + echo 'isrunning=$(ps aux | grep ices2)' >> /usr/bin/start_icecast + echo 'if [[ "$isrunning" != *"ices-playlist"* ]]; then' >> /usr/bin/start_icecast + echo ' systemctl start icecast2' >> /usr/bin/start_icecast + echo ' sleep 3' >> /usr/bin/start_icecast + echo ' cd /etc/ices2' >> /usr/bin/start_icecast + echo ' ices2 ices-playlist.xml' >> /usr/bin/start_icecast + echo 'fi' >> /usr/bin/start_icecast + chmod +x /usr/bin/start_icecast + + echo '[Unit]' > /etc/systemd/system/icecast2.service + echo 'Description=Icecast' >> /etc/systemd/system/icecast2.service + echo 'After=network.target' >> /etc/systemd/system/icecast2.service + echo 'After=tor.service' >> /etc/systemd/system/icecast2.service + echo '' >> /etc/systemd/system/icecast2.service + echo '[Service]' >> /etc/systemd/system/icecast2.service + echo 'User=icecast2' >> /etc/systemd/system/icecast2.service + echo 'Group=icecast' >> /etc/systemd/system/icecast2.service + echo 'ExecStart=/usr/bin/icecast2 -c /etc/icecast2/icecast.xml' >> /etc/systemd/system/icecast2.service + echo 'Restart=on-failure' >> /etc/systemd/system/icecast2.service + echo 'RestartSec=10' >> /etc/systemd/system/icecast2.service + echo '' >> /etc/systemd/system/icecast2.service + echo '[Install]' >> /etc/systemd/system/icecast2.service + echo 'WantedBy=multi-user.target' >> /etc/systemd/system/icecast2.service + + chown -R icecast2:icecast /etc/ices2 + chown -R icecast2:icecast /etc/icecast2 + systemctl daemon-reload + systemctl enable icecast2 + + if ! grep -q "start_icecast" /etc/crontab; then + echo '*/1 * * * * root /usr/bin/start_icecast > /dev/null' >> /etc/crontab + fi +} + +function change_password_icecast { + curr_username="$1" + new_user_password="$2" + + stop_icecast + + sed -i -e "s|[^<]*|$new_user_password|" \ + -e "s|[^<]*|$new_user_password|" \ + -e "s|[^<]*|$new_user_password|" \ + /etc/icecast2/icecast.xml + sed -i "s|.*|${new_user_password}|g" /etc/ices2/ices-playlist.xml + + ${PROJECT_NAME}-pass -u "$curr_username" -a icecast -p "$new_user_password" + start_icecast +} + +function logging_on_icecast { + echo -n '' +} + +function logging_off_icecast { + echo -n '' +} + +function reconfigure_icecast { + echo -n '' +} + +function icecast_convert_files { + clear + cd ${1} + + echo $'Converting any mp3 files to ogg format' + find . -type f -name '*.mp3' -exec bash -c 'ffmpeg -i "$0" -c:a libvorbis -q:a 4 "${0/%mp3/ogg}"' '{}' \; + find . -name "*.mp3" -print0 | xargs -0 rm -f + + echo $'Converting any mp4 files to ogv format' + find . -type f -name '*.mp4' -exec bash -c 'ffmpeg -i "$0" -c:a libvorbis -q:a 4 "${0/%mp3/ogv}"' '{}' \; + find . -name "*.mp4" -print0 | xargs -0 rm -f + + chown -R icecast2:icecast $ICECAST_DIR +} + +function icecast_add_file_to_playlist { + files_dir=${1} + if [ ! -d $files_dir ]; then + return + fi + + echo $'Adding ogg files to playlist' + find $files_dir -type f -name '*.ogg' -print0 | while read -d $'\0' file; do + if ! grep -q "$file" $ICECAST_PLAYLIST_FILE; then + echo "$file" >> $ICECAST_PLAYLIST_FILE + fi + done + + echo $'Adding ogv files to playlist' + find $files_dir -type f -name '*.ogv' -print0 | while read -d $'\0' file; do + if ! grep -q "$file" $ICECAST_PLAYLIST_FILE; then + echo "$file" >> $ICECAST_PLAYLIST_FILE + fi + done + + chown icecast2:icecast $ICECAST_PLAYLIST_FILE + stop_icecast + start_icecast +} + +function icecast_import_from_directory { + data=$(tempfile 2>/dev/null) + dialog --title "Choose a directory containing stream files" --dselect /home/$MY_USERNAME/ 30 60 2> $data + selected_dir=$(cat $data) + rm $data + if [[ "$selected_dir" == "$ICECAST_DIR" ]]; then + return + fi + if [ ! -d $selected_dir ]; then + return + fi + if [[ "$selected_dir" == "/home/$MY_USERNAME/" ]]; then + return + fi + if [[ "$selected_dir" == "/home/$MY_USERNAME/."* ]]; then + return + fi + if [[ "$selected_dir" == *"/Maildir" || "$selected_dir" == *"/Sync" ]]; then + return + fi + + dialog --title $"Import stream files directory into Icecast" \ + --backtitle $"Freedombone Control Panel" \ + --defaultno \ + --yesno $"\nImport the directory:\n\n $selected_dir" 12 75 + sel=$? + case $sel in + 1) return;; + 255) return;; + esac + + if [ ! -d $ICECAST_DIR ]; then + mkdir -p $ICECAST_DIR + fi + + dest_dir=$(basename "$selected_dir") + mv "$selected_dir" $ICECAST_DIR + + icecast_convert_files $ICECAST_DIR/$dest_dir + icecast_add_file_to_playlist $ICECAST_DIR/$dest_dir + + dialog --title $"Import stream files directory into Icecast" \ + --msgbox $"Import success" 6 40 +} + +function icecast_import_from_usb { + clear + detect_usb_drive + + if [ ! -b $USB_DRIVE ]; then + dialog --title $"Import stream files from USB drive" --msgbox $'No USB drive found' 6 50 + return + fi + + backup_mount_drive ${USB_DRIVE} + if [ ! -d $USB_MOUNT$ICECAST_DIR ]; then + dialog --title $"Import stream files from USB drive" --msgbox $'No stream files directory found on USB drive' 6 50 + backup_unmount_drive ${USB_DRIVE} + fi + cp -ru $USB_MOUNT$ICECAST_DIR/* $ICECAST_DIR + backup_unmount_drive ${USB_DRIVE} + icecast_convert_files $ICECAST_DIR + dialog --title $"Import stream files from USB drive" --msgbox $'Import complete. You may now remove the USB drive' 6 50 +} + +function icecast_export_to_usb { + clear + detect_usb_drive + + if [ ! -b $USB_DRIVE ]; then + dialog --title $"Export stream files to USB drive" --msgbox $'No USB drive found' 6 50 + return + fi + + backup_mount_drive ${USB_DRIVE} + if [ ! -d $USB_MOUNT$ICECAST_DIR ]; then + mkdir -p $USB_MOUNT$ICECAST_DIR + fi + cp -ru $ICECAST_DIR/* $USB_MOUNT$ICECAST_DIR + backup_unmount_drive ${USB_DRIVE} + dialog --title $"Export stream files to USB drive" --msgbox $'Export complete. You may now remove the USB drive' 6 50 +} + +function icecast_format_drive { + detect_usb_drive + data=$(tempfile 2>/dev/null) + trap "rm -f $data" 0 1 2 5 15 + dialog --title $"Format USB drive $USB_DRIVE for stream file storage" \ + --backtitle $"Freedombone Control Panel" \ + --defaultno \ + --yesno $"\nPlease confirm that you wish to format drive\n\n ${USB_DRIVE}\n\nAll current data on the drive will be lost, and you will be prompted to give a password used to encrypt the drive.\n\nDANGER: If you screw up here and format the wrong drive it's your own fault!" 16 60 + sel=$? + case $sel in + 1) return;; + 255) return;; + esac + rm $data + + clear + echo '' + echo $"Formatting drive $USB_DRIVE. ALL CONTENTS WILL BE LOST." + echo '' + ${PROJECT_NAME}-format $USB_DRIVE + dialog --title $"Format USB drive $USB_DRIVE for stream file storage" --msgbox $'Format complete. You may now export stream files or remove the USB drive' 6 50 +} + +function icecast_edit_playlist { + editor $ICECAST_PLAYLIST_FILE + stop_icecast + start_icecast +} + +function icecast_change_login { + read_config_param $MY_USERNAME + ICECAST_USER_PASSWORD=$(${PROJECT_NAME}-pass -u $MY_USERNAME -a icecastuser) + + data=$(tempfile 2>/dev/null) + trap "rm -f $data" 0 1 2 5 15 + dialog --title $"Change Icecast stream visitor login" \ + --backtitle $"Freedombone Control Panel" \ + --inputbox $"Enter the new login password for stream visitors" 8 60 "$ICECAST_USER_PASSWORD" 2>$data + sel=$? + case $sel in + 0) ICECAST_USER_PASSWORD=$(<$data) + if [[ "$ICECAST_USER_PASSWORD" != *' '* ]]; then + if [ ${#ICECAST_USER_PASSWORD} -gt 8 ]; then + ${PROJECT_NAME}-pass -u $MY_USERNAME -a icecastuser -p $ICECAST_USER_PASSWORD + dialog --title $"Change Icecast stream visitor login" \ + --msgbox $"Password changed to $ICECAST_USER_PASSWORD" 6 75 + fi + fi + ;; + esac + rm $data +} + +function icecast_enable_login { + dialog --title $"Enable Icecast login" \ + --backtitle $"Freedombone Control Panel" \ + --defaultno \ + --yesno $"\nDo you want to add a login so that random web users can't access your stream?" 10 60 + sel=$? + case $sel in + 0) if grep -q '#auth_basic' /etc/nginx/sites-available/icecast; then + sed -i 's|#auth_basic|auth_basic|g' /etc/nginx/sites-available/icecast + systemctl restart nginx + fi + read_config_param $MY_USERNAME + ICECAST_USER_PASSWORD=$(${PROJECT_NAME}-pass -u $MY_USERNAME -a icecastuser) + dialog --title $"Enable Icecast login" \ + --msgbox $"Icecast logins are now enabled with the password $ICECAST_USER_PASSWORD" 6 65 + ICECAST_USER_PASSWORD= + ;; + 1) if ! grep -q '#auth_basic' /etc/nginx/sites-available/icecast; then + sed -i 's|auth_basic|#auth_basic|g' /etc/nginx/sites-available/icecast + systemctl restart nginx + fi + dialog --title $"Disable Icecast login" \ + --msgbox $"Icecast logins are now disabled. Anyone can access your stream." 6 65 + ;; + esac +} + +function icecast_set_stream_name { + data=$(tempfile 2>/dev/null) + trap "rm -f $data" 0 1 2 5 15 + dialog --backtitle $"Freedombone Control Panel" \ + --title $"Change Icecast stream details" \ + --form "\n" 8 60 4 \ + $"Stream name:" 1 1 "Example stream name" 1 18 40 1000 \ + $"Description:" 2 1 "A short description of your stream" 2 18 40 1000 \ + $"Genre:" 3 1 "Example genre" 3 18 40 1000 \ + 2> $data + sel=$? + case $sel in + 1) return;; + 255) return;; + esac + stream_name=$(cat $data | sed -n 1p) + stream_description=$(cat $data | sed -n 2p) + stream_genre=$(cat $data | sed -n 3p) + if [ ${#stream_name} -gt 2 ]; then + sed -i "s|.*|${stream_name}|g" /etc/ices2/ices-playlist.xml + fi + if [ ${#stream_description} -gt 2 ]; then + sed -i "s|.*|${stream_description}|g" /etc/ices2/ices-playlist.xml + fi + if [ ${#stream_genre} -gt 2 ]; then + sed -i "s|.*|${stream_genre}|g" /etc/ices2/ices-playlist.xml + fi + rm $data + stop_icecast + start_icecast +} + +function icecast_set_maximum_streams { + data=$(tempfile 2>/dev/null) + trap "rm -f $data" 0 1 2 5 15 + dialog --title $"Set the maximum clients" \ + --backtitle $"Freedombone Control Panel" \ + --inputbox $"Maximum number of clients" 8 40 "10" 2>$data + sel=$? + case $sel in + 0) + max_clients=$(<$data) + if [ ${#max_clients} -gt 0 ]; then + if [[ "$max_clients" != *' '* ]]; then + if [[ $max_clients =~ '^[0-9]+$' ]] ; then + sed -i "s|.*|${max_clients}|g" /etc/icecast2/icecast.xml + stop_icecast + start_icecast + dialog --title $"Set the maximum clients" \ + --msgbox $"\nMaximum Icecast clients was set to ${max_clients}" 8 50 + fi + fi + fi + ;; + esac + rm $data +} + +function configure_interactive_icecast { + while true + do + data=$(tempfile 2>/dev/null) + trap "rm -f $data" 0 1 2 5 15 + dialog --backtitle $"Freedombone Control Panel" \ + --title $"Icecast" \ + --radiolist $"Choose an operation:" 19 70 12 \ + 1 $"Import stream files from directory" off \ + 2 $"Import stream files from USB drive" off \ + 3 $"Format a USB drive for stream file storage" off \ + 4 $"Export stream files to USB drive" off \ + 5 $"Manually edit playlist" off \ + 6 $"Enable login for stream visitors" off \ + 7 $"Change password for stream visitors" off \ + 8 $"Re-scan playlist" off \ + 9 $"Restart stream" off \ + 10 $"Set Stream Name/Description/Genre" off \ + 11 $"Set maximum number of clients/streams" off \ + 12 $"Exit" on 2> $data + sel=$? + case $sel in + 1) break;; + 255) break;; + esac + case $(cat $data) in + 1) icecast_import_from_directory;; + 2) icecast_import_from_usb;; + 3) icecast_format_drive;; + 4) icecast_export_to_usb;; + 5) icecast_edit_playlist;; + 6) icecast_enable_login;; + 7) icecast_change_login;; + 8) clear + echo $'Rescanning Icecast playlist' + icecast_rescan;; + 9) clear + echo $'Restarting Icecast stream' + stop_icecast + start_icecast;; + 10) icecast_set_stream_name;; + 11) icecast_set_maximum_streams;; + 12) break;; + esac + done +} + +function upgrade_icecast { + icecast_update_daemon +} + +function backup_local_icecast { + if [ ! -d $ICECAST_DIR ]; then + return + fi + stop_icecast + + cp /etc/nginx/.icepasswd $ICECAST_DIR + cp /etc/ices2/ices-playlist.xml $ICECAST_DIR + + function_check backup_directory_to_usb + backup_directory_to_usb $ICECAST_DIR icecast + + rm $ICECAST_DIR/.icepasswd + start_icecast +} + +function restore_local_icecast { + if [ ! -d $ICECAST_DIR ]; then + return + fi + stop_icecast + temp_restore_dir=/root/tempicecast + function_check restore_directory_from_usb + restore_directory_from_usb $temp_restore_dir icecast + if [ -d $temp_restore_dir$ICECAST_DIR ]; then + cp -r $temp_restore_dir$ICECAST_DIR $ICECAST_DIR/ + else + cp -r $temp_restore_dir/* $ICECAST_DIR/* + fi + cp $ICECAST_DIR/.icepasswd /etc/nginx/.icepasswd + rm $ICECAST_DIR/.icepasswd + cp $ICECAST_DIR/ices-playlist.xml /etc/ices2 + rm $ICECAST_DIR/ices-playlist.xml + chown -R icecast2:icecast $ICECAST_DIR + chown -R icecast2:icecast /etc/ices2 + + start_icecast + rm -rf $temp_restore_dir +} + +function backup_remote_icecast { + if [ ! -d $ICECAST_DIR ]; then + return + fi + stop_icecast + + cp /etc/nginx/.icepasswd $ICECAST_DIR + cp /etc/ices2/ices-playlist.xml $ICECAST_DIR + + function_check backup_directory_to_friend + backup_directory_to_friend $ICECAST_DIR icecast + + rm $ICECAST_DIR/.icepasswd + start_icecast +} + +function restore_remote_icecast { + if [ ! -d $ICECAST_DIR ]; then + return + fi + stop_icecast + temp_restore_dir=/root/tempicecast + function_check restore_directory_from_friend + restore_directory_from_friend $temp_restore_dir icecast + if [ -d $temp_restore_dir$ICECAST_DIR ]; then + cp -r $temp_restore_dir$ICECAST_DIR $ICECAST_DIR/ + else + cp -r $temp_restore_dir/* $ICECAST_DIR/* + fi + cp $ICECAST_DIR/.icepasswd /etc/nginx/.icepasswd + rm $ICECAST_DIR/.icepasswd + cp $ICECAST_DIR/ices-playlist.xml /etc/ices2 + rm $ICECAST_DIR/ices-playlist.xml + chown -R icecast2:icecast $ICECAST_DIR + + start_icecast + rm -rf $temp_restore_dir +} + +function remove_icecast { + nginx_dissite icecast + + sed -i '/start_icecast/d' /etc/crontab + stop_icecast + systemctl disable icecast2 + rm /etc/systemd/system/icecast2.service + rm /usr/bin/start_icecast + rm /usr/bin/stop_icecast + + if [ -f /etc/nginx/sites-available/icecast ]; then + rm /etc/nginx/sites-available/icecast + fi + + if [ -d /var/www/icecast ]; then + rm -rf /var/www/icecast + fi + + apt-get -yq remove --purge icecast2 + + if [ -d /etc/icecast2 ]; then + rm -rf /etc/icecast2 + fi + if [ -d /etc/ices2 ]; then + rm -rf /etc/ices2 + fi + function_check remove_onion_service + remove_onion_service icecast ${ICECAST_ONION_PORT} + sed -i '/icecast/d' $COMPLETION_FILE +} + +function install_icecast { + apt-get -yq install software-properties-common debconf-utils + apt-get -yq update + + debconf-set-selections <<< "icecast2 icecast2/icecast-setup boolean false" + apt-get -yq install icecast2 + apt-get -yq install ices2 ffmpeg apache2-utils + + if [ ! -f /etc/icecast2/icecast.xml ]; then + echo $'Icecast not installed' + exit 7923528 + fi + + if [ ! ${ICECAST_PASSWORD} ]; then + if [ -f ${IMAGE_PASSWORD_FILE} ]; then + ICECAST_PASSWORD="$(printf `cat $IMAGE_PASSWORD_FILE`)" + else + ICECAST_PASSWORD="$(create_password ${MINIMUM_PASSWORD_LENGTH})" + fi + fi + + ICECAST_ONION_HOSTNAME=$(add_onion_service icecast 80 ${ICECAST_ONION_PORT}) + + sed -i -e "s|[^<]*|$ICECAST_PASSWORD|" \ + -e "s|[^<]*|$ICECAST_PASSWORD|" \ + -e "s|[^<]*|$ICECAST_PASSWORD|" \ + -e "s|[^<]*|$ICECAST_ONION_HOSTNAME|" \ + /etc/icecast2/icecast.xml + + sed -i "s|.*|10|g" /etc/icecast2/icecast.xml + sed -i "s|.*|$ICECAST_PORT|g" /etc/icecast2/icecast.xml + sed -i "s|.*|$MY_USERNAME|g" /etc/icecast2/icecast.xml + sed -i "s|.*|$MY_EMAIL_ADDRESS|g" /etc/icecast2/icecast.xml + sed -i "s|.*|The Interwebs|g" /etc/icecast2/icecast.xml + #sed -i 's|' >> /etc/ices2/ices-playlist.xml + echo ' 1' >> /etc/ices2/ices-playlist.xml + echo ' ' >> /etc/ices2/ices-playlist.xml + echo ' /var/log/ices' >> /etc/ices2/ices-playlist.xml + echo ' ices.log' >> /etc/ices2/ices-playlist.xml + echo ' ' >> /etc/ices2/ices-playlist.xml + echo ' 1' >> /etc/ices2/ices-playlist.xml + echo ' ' >> /etc/ices2/ices-playlist.xml + echo ' 0' >> /etc/ices2/ices-playlist.xml + echo '' >> /etc/ices2/ices-playlist.xml + echo ' ' >> /etc/ices2/ices-playlist.xml + echo ' ' >> /etc/ices2/ices-playlist.xml + echo '' >> /etc/ices2/ices-playlist.xml + echo ' ' >> /etc/ices2/ices-playlist.xml + echo ' ' >> /etc/ices2/ices-playlist.xml + echo ' ' >> /etc/ices2/ices-playlist.xml + echo ' Example stream name' >> /etc/ices2/ices-playlist.xml + echo ' Example genre' >> /etc/ices2/ices-playlist.xml + echo ' A short description of your stream' >> /etc/ices2/ices-playlist.xml + echo ' ' >> /etc/ices2/ices-playlist.xml + echo '' >> /etc/ices2/ices-playlist.xml + echo ' ' >> /etc/ices2/ices-playlist.xml + echo '' >> /etc/ices2/ices-playlist.xml + echo ' ' >> /etc/ices2/ices-playlist.xml + echo ' playlist' >> /etc/ices2/ices-playlist.xml + echo ' basic' >> /etc/ices2/ices-playlist.xml + echo " $ICECAST_PLAYLIST_FILE" >> /etc/ices2/ices-playlist.xml + echo ' ' >> /etc/ices2/ices-playlist.xml + echo ' 0' >> /etc/ices2/ices-playlist.xml + echo ' ' >> /etc/ices2/ices-playlist.xml + echo ' 0' >> /etc/ices2/ices-playlist.xml + echo ' ' >> /etc/ices2/ices-playlist.xml + echo ' 0' >> /etc/ices2/ices-playlist.xml + echo ' ' >> /etc/ices2/ices-playlist.xml + echo '' >> /etc/ices2/ices-playlist.xml + echo ' ' >> /etc/ices2/ices-playlist.xml + echo ' ' >> /etc/ices2/ices-playlist.xml + echo ' ' >> /etc/ices2/ices-playlist.xml + echo ' localhost' >> /etc/ices2/ices-playlist.xml + echo " $ICECAST_PORT" >> /etc/ices2/ices-playlist.xml + echo " $ICECAST_PASSWORD" >> /etc/ices2/ices-playlist.xml + echo ' /example1.ogg' >> /etc/ices2/ices-playlist.xml + echo ' ' >> /etc/ices2/ices-playlist.xml + echo ' 2' >> /etc/ices2/ices-playlist.xml + echo ' 5 ' >> /etc/ices2/ices-playlist.xml + echo '' >> /etc/ices2/ices-playlist.xml + echo ' ' >> /etc/ices2/ices-playlist.xml + echo ' 80' >> /etc/ices2/ices-playlist.xml + echo '' >> /etc/ices2/ices-playlist.xml + echo ' ' >> /etc/ices2/ices-playlist.xml + echo ' ' >> /etc/ices2/ices-playlist.xml + echo ' 64000' >> /etc/ices2/ices-playlist.xml + echo ' 22050' >> /etc/ices2/ices-playlist.xml + echo ' 1' >> /etc/ices2/ices-playlist.xml + echo ' ' >> /etc/ices2/ices-playlist.xml + echo ' ' >> /etc/ices2/ices-playlist.xml + echo '' >> /etc/ices2/ices-playlist.xml + echo ' ' >> /etc/ices2/ices-playlist.xml + echo '' >> /etc/ices2/ices-playlist.xml + + sed -i 's|ENABLE=.*|ENABLE=true|g' /etc/default/icecast2 + + if [ ! -d $ICECAST_DIR ]; then + mkdir $ICECAST_DIR + fi + chown -R icecast2:icecast $ICECAST_DIR + + + # create a password for users + ICECAST_USER_PASSWORD="$(create_password ${MINIMUM_PASSWORD_LENGTH})" + if grep -q "$MY_USERNAME:" /etc/nginx/.icepasswd; then + sed -i "/$MY_USERNAME:/d" /etc/nginx/.icepasswd + fi + echo "$ICECAST_USER_PASSWORD" | htpasswd -i -s -c /etc/nginx/.icepasswd $MY_USERNAME + if [ ! -f /etc/nginx/.icepasswd ]; then + echo $'/etc/nginx/.icepasswd not found' + exit 73528235 + fi + + ${PROJECT_NAME}-pass -u $MY_USERNAME -a icecast -p "$ICECAST_PASSWORD" + ${PROJECT_NAME}-pass -u $MY_USERNAME -a icecastuser -p "$ICECAST_USER_PASSWORD" + + groupadd icecast + useradd -c "Icecast system account" -d /etc/icecast2 -m -r -g icecast icecast2 + + icecast_update_daemon + nginx_ensite icecast + systemctl restart nginx + icecast_rescan + start_icecast + + APP_INSTALLED=1 +} + +function install_interactive_icecast { + install_icecast +} + +# NOTE: deliberately no exit 0 diff --git a/src/freedombone-app-koel b/src/freedombone-app-koel index c5447035..9a21b07c 100755 --- a/src/freedombone-app-koel +++ b/src/freedombone-app-koel @@ -175,7 +175,7 @@ function reconfigure_koel { function koel_import_from_directory { data=$(tempfile 2>/dev/null) - dialog --title "test" --dselect /home/$MY_USERNAME/ 30 60 2> $data + dialog --title "Choose a directory containing music" --dselect /home/$MY_USERNAME/ 30 60 2> $data selected_dir=$(cat $data) rm $data if [[ "$selected_dir" == '/music' ]]; then diff --git a/website/EN/app_icecast.html b/website/EN/app_icecast.html new file mode 100644 index 00000000..3cc8ce3e --- /dev/null +++ b/website/EN/app_icecast.html @@ -0,0 +1,376 @@ + + + + + + + +‎ + + + + + + + + + +
+ +
+
+
+ +
+

logo.png +

+
+
+ +
+

Icecast

+
+ +

+Icecast enables you to run something like an internet radio station. So if you have multiple audio files and want to be able to stream those in sequence from a web site then this can be useful. +

+ +

+This system is available only via an onion address, which should mitigate the potential for copyright disputes over streamed content. By default it's only set up to stream to a small number of users so that it doesn't put too much stress on CPU or memory requirements, although you can increase the maximum limit if you have a more powerful system and enough bandwidth. +

+ +
+

Installation

+
+

+Log into your system with: +

+ +
+
ssh myusername@mydomain -p 2222
+
+
+ +

+Using cursor keys, space bar and Enter key select Administrator controls and type in your password. +

+ +

+Select Add/Remove Apps. If Vim is selected then you might want to unselect and uninstall it first, then select icecast. +

+ +

+If you then go to the About screen you'll see the onion address for Icecast and can navigate to it in a Tor compatible browser. +

+
+
+ +
+

Adding files to be streamed

+
+

+There are two ways to get files onto the system: either via ssh or via a USB drive. File types can be ogg, ogv, mp3 or mp4 format. +

+ +

+It may take a while for the files to import, especially on a low power single board computer, since any mp3 or mp4 files will be converted to ogg or ogv. If you want to speed this up then you could do this conversion manually on a laptop with ffmpeg before storing files onto the USB drive or uploading them via ssh. +

+
+ +
+

From a USB drive

+
+

+Create a directory on the USB drive named icestream and copy your files into there. Plug the drive into your server. +

+ +

+Go to the Administrator control panel, select App settings, then icecast, then Import stream files from USB drive. +

+
+
+ +
+

Via ssh

+
+

+Make a directory named icestream and copy your files into it. Then copy the directory to your server. +

+ +
+
scp -r -P 2222 icestream myusername@mydomain:/home/myusername
+
+
+ +

+Log into your server with: +

+ +
+
ssh myusername@mydomain -p 2222
+
+
+ +

+Select Administrator controls, enter your password, then go to App settings followed by icecast and Import stream files. Choose the directory with up and down cursors and space bar to select. +

+
+
+
+ +
+

Access controls

+
+

+By default anyone who happens to find your Icecast onion address can listen to your stream. If you only want it to be available to a few friends or family then you can add an extra login password. +

+ +

+Go to the Administrator control panel, select App settings, then icecast, then Enable login for stream users. Take a note of the password and you can give that out to whoever needs access, preferably via an encrypted chat app or sneakernet. If you need to copy and paste then hold the shift key while highlighting the password. +

+
+
+
+
+ + + +
+Back to top | E-mail me +
+
+ + diff --git a/website/EN/apps.html b/website/EN/apps.html index 0f1ef236..4915f237 100644 --- a/website/EN/apps.html +++ b/website/EN/apps.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - + ‎ @@ -264,9 +264,9 @@ The base install of the system just contains an email server and Mutt client, bu -
-

CryptPad

-
+
+

CryptPad

+

Collaborate on editing documents, presentations and source code, or vote on things. All with a good level of security.

@@ -276,9 +276,9 @@ Collaborate on editing documents, presentations and source code, or vote on thin

-
-

DLNA

-
+
+

DLNA

+

Enables you to use the system as a music server which any DLNA compatible devices can connect to within your home network.

@@ -288,9 +288,9 @@ Enables you to use the system as a music server which any DLNA compatible device

-
-

Dokuwiki

-
+
+

Dokuwiki

+

A databaseless wiki system.

@@ -300,9 +300,9 @@ A databaseless wiki system.

-
-

Emacs

-
+
+

Emacs

+

If you use the Mutt client to read your email then this will set it up to use emacs for composing new mail.

@@ -312,9 +312,9 @@ If you use the Mutt client to read your email then this will set it up to use em

-
-

Etherpad

-
+
+

Etherpad

+

Collaborate on creating documents in real time. Maybe you're planning a holiday with other family members or creating documentation for a Free Software project along with other volunteers. Etherpad is hard to beat for simplicity and speed. Only users of the system will be able to access it.

@@ -324,9 +324,9 @@ Collaborate on creating documents in real time. Maybe you're planning a holiday

-
-

Friendica

-
+
+

Friendica

+

Federated social network system.

@@ -336,9 +336,9 @@ Federated social network system.

-
-

Ghost

-
+
+

Ghost

+

Modern looking blogging system.

@@ -348,9 +348,9 @@ Modern looking blogging system.

-
-

GNU Social

-
+
+

GNU Social

+

Federated social network based on the OStatus protocol. You can "remote follow" other users within the GNU Social federation.

@@ -360,9 +360,9 @@ Federated social network based on the OStatus protocol. You can "remote follo

-
-

Gogs

-
+
+

Gogs

+

Lightweight git project hosting system. You can mirror projects from Github, or if Github turns evil then just host your own projects while retaining the familiar fork-and-pull workflow. If you can use Github then you can also use Gogs.

@@ -372,9 +372,9 @@ Lightweight git project hosting system. You can mirror projects from Github, or

-
-

HTMLy

-
+
+

HTMLy

+

Databaseless blogging system. Quite simple and with a markdown-like format.

@@ -384,9 +384,9 @@ Databaseless blogging system. Quite simple and with a markdown-like format.

-
-

Hubzilla

-
+
+

Hubzilla

+

Web publishing platform with social network like features and good privacy controls so that it's possible to specify who can see which content. Includes photo albums, calendar, wiki and file storage.

@@ -396,9 +396,21 @@ Web publishing platform with social network like features and good privacy contr

-
-

IRC Server (ngirc)

-
+
+

Icecast media stream

+
+

+Make your own internet radio station. +

+ +

+How to use it +

+
+
+
+

IRC Server (ngirc)

+

Run your own IRC chat channel which can be secured with a password and accessible via an onion address. A bouncer is included so that you can receive messages sent while you were offline. Works with Hexchat and other popular clients.

@@ -408,18 +420,18 @@ Run your own IRC chat channel which can be secured with a password and accessibl

-
-

Jitsi Meet

-
+
+

Jitsi Meet

+

Experimental WebRTC video conferencing system, similar to Google Hangouts. This may not be fully functional, but is hoped to be in the near future.

-
-

KanBoard

-
+
+

KanBoard

+

A simple kanban system for managing projects or TODO lists.

@@ -429,9 +441,9 @@ A simple kanban system for managing projects or TODO lists.

-
-

Key Server

-
+
+

Key Server

+

An OpenPGP key server for storing and retrieving GPG public keys.

@@ -441,9 +453,9 @@ An OpenPGP key server for storing and retrieving GPG public keys.

-
-

Koel

-
+
+

Koel

+

Access your music collection from any internet connected device.

@@ -453,9 +465,9 @@ Access your music collection from any internet connected device.

-
-

Lychee

-
+
+

Lychee

+

Make your photo albums available on the web.

@@ -465,9 +477,9 @@ Make your photo albums available on the web.

-
-

Mailpile

-
+
+

Mailpile

+

Modern email client which supports GPG encryption.

@@ -477,9 +489,9 @@ Modern email client which supports GPG encryption.

-
-

Matrix

-
+
+

Matrix

+

Multi-user chat with some security and moderation controls.

@@ -489,9 +501,9 @@ Multi-user chat with some security and moderation controls.

-
-

Mediagoblin

-
+
+

Mediagoblin

+

Publicly host video and audio files so that you don't need to use YouTube/Vimeo/etc.

@@ -501,9 +513,9 @@ Publicly host video and audio files so that you don't need to use YouTube/Vimeo/

-
-

Mumble

-
+
+

Mumble

+

The popular VoIP and text chat system. Say goodbye to old-fashioned telephony conferences with silly dial codes. Also works well on mobile.

@@ -513,9 +525,9 @@ The popular VoIP and text chat system. Say goodbye to old-fashioned telephony co

-
-

NextCloud

-
+
+

NextCloud

+

Store files on your server and sync them with laptops or mobile devices. Includes many plugins including videoconferencing and collaborative document editing.

@@ -525,9 +537,9 @@ Store files on your server and sync them with laptops or mobile devices. Include

-
-

PI-Hole

-
+
+

PI-Hole

+

The black hole for web adverts. Block adverts at the domain name level within your local network. It can significantly reduce bandwidth, speed up page load times and protect your systems from being tracked by spyware.

@@ -537,9 +549,9 @@ The black hole for web adverts. Block adverts at the domain name level within yo

-
-

Pleroma

-
+
+

Pleroma

+

Pleroma is an OStatus-compatible social networking server, compatible with GNU Social, PostActiv and Mastodon. It is high-performance and so is especially well suited for running on low power single board computers without much RAM.

@@ -549,9 +561,9 @@ Pleroma is an OStatus-compatible social networking server, compatible with GNU S

-
-

PostActiv

-
+
+

PostActiv

+

An alternative federated social networking system compatible with GNU Social, Pleroma and Mastodon. It includes some optimisations and fixes currently not available within the main GNU Social project.

@@ -561,9 +573,9 @@ An alternative federated social networking system compatible with GNU Social, Pl

-
-

Profanity

-
+
+

Profanity

+

A shell based XMPP client which you can run on the Freedombone server via ssh.

@@ -573,9 +585,9 @@ A shell based XMPP client which you can run on the Freedombone server via ssh.

-
-

Riot Web

-
+
+

Riot Web

+

A browser based user interface for the Matrix federated communications system, including WebRTC audio and video chat.

@@ -585,9 +597,9 @@ A browser based user interface for the Matrix federated communications system, i

-
-

SearX

-
+
+

SearX

+

A metasearch engine for customised and private web searches.

@@ -597,9 +609,9 @@ A metasearch engine for customised and private web searches.

-
-

tt-rss

-
+
+

tt-rss

+

Private RSS reader. Pulls in RSS/Atom feeds via Tor and is only accessible via an onion address. Have "the right to read" without the Surveillance State knowing what you're reading. Also available with a user interface suitable for viewing on mobile devices via a browser such as OrFox.

@@ -609,9 +621,9 @@ Private RSS reader. Pulls in RSS/Atom feeds via Tor and is only accessible via a

-
-

Syncthing

-
+
+

Syncthing

+

Possibly the best way to synchronise files across all of your devices. Once it has been set up it "just works" with no user intervention needed.

@@ -621,9 +633,9 @@ Possibly the best way to synchronise files across all of your devices. Once it h

-
-

Tahoe-LAFS

-
+
+

Tahoe-LAFS

+

Robust and encrypted storage of files on one or more server.

@@ -633,9 +645,9 @@ Robust and encrypted storage of files on one or more server.

-
-

Tox

-
+
+

Tox

+

Client and bootstrap node for the Tox chat/VoIP system.

@@ -645,9 +657,9 @@ Client and bootstrap node for the Tox chat/VoIP system.

-
-

Turtl

-
+
+

Turtl

+

A system for privately creating and sharing notes and images, similar to Evernote but without the spying.

@@ -657,18 +669,18 @@ A system for privately creating and sharing notes and images, similar to Evernot

-
-

Vim

-
+
+

Vim

+

If you use the Mutt client to read your email then this will set it up to use vim for composing new mail.

-
-

Virtual Private Network (VPN)

-
+
+

Virtual Private Network (VPN)

+

Set up a VPN on your server so that you can bypass local internet censorship.

@@ -678,9 +690,9 @@ Set up a VPN on your server so that you can bypass local internet censorship.

-
-

XMPP

-
+
+

XMPP

+

Chat server which can be used together with client such as Gajim or Conversations to provide end-to-end content security and also onion routed metadata security. Includes advanced features such as client state notification to save battery power on your mobile devices, support for seamless roaming between networks and message carbons so that you can receive the same messages while being simultaneously logged in to your account on more than one device.

diff --git a/website/EN/meshindex.html b/website/EN/meshindex.html index 032ccdf2..30aecd5b 100644 --- a/website/EN/meshindex.html +++ b/website/EN/meshindex.html @@ -3,7 +3,7 @@ "http://www.w3.org/TR/xhtml1/DTD/xhtml1-strict.dtd"> - + ‎