From ec2ec899d8b28c0d11a04ad8444cc8677265f5fc Mon Sep 17 00:00:00 2001 From: "Buster \"Silver Eagle\" Neece" Date: Mon, 15 Feb 2021 15:36:34 -0600 Subject: [PATCH] Update links across application to point to new documentation. --- .github/ISSUE_TEMPLATE/bug_report.md | 15 +- .github/ISSUE_TEMPLATE/config.yml | 30 ++-- CHANGELOG.md | 2 +- CODE_OF_CONDUCT.md | 3 +- CONTRIBUTING.md | 74 +++++++--- README.md | 128 ++++++++++++------ SUPPORT.md | 5 +- config/forms/settings.php | 2 +- docker-compose.sample.yml | 4 +- .../form/PlaylistFormBasicInfo.vue | 2 +- src/Version.php | 2 +- templates/frontend/account/login.phtml | 45 ++++-- templates/main.phtml | 4 +- templates/minimal.phtml | 20 +-- templates/partials/log_help_card.phtml | 12 +- templates/stations/streamers/index.phtml | 44 ++++-- 16 files changed, 260 insertions(+), 132 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 7d4dc5c5d..4181481b5 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,14 +1,13 @@ --- -name: Bug Report -about: Report an error you're encountering with your AzuraCast installation. +name: Bug Report about: Report an error you're encountering with your AzuraCast installation. --- **Using Docker installation method** @@ -51,11 +50,11 @@ Steps to reproduce the behavior: **Device(s):** - - Device: - - OS: - - Browser: - - Version: +- Device: +- OS: +- Browser: +- Version: **Additional context** diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml index b7539d7ed..9ac1c5f32 100644 --- a/.github/ISSUE_TEMPLATE/config.yml +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -1,18 +1,18 @@ -blank_issues_enabled: false +blank_issues_enabled : false -contact_links: - - name: AzuraCast Help Page - url: https://www.azuracast.com/help/ - about: Check the AzuraCast help page for solutions to common problems. +contact_links : + - name : AzuraCast Help Page + url : https://docs.azuracast.com/en/user-guide/troubleshooting + about : Check the AzuraCast help page for solutions to common problems. - - name: New Feature Suggestion - url: https://features.azuracast.com - about: Submit an idea for a new feature via our FeatureUpvote site. - - - name: Submit New Translations - url: https://translate.azuracast.com - about: Submit and manage translations for the AzuraCast application. + - name : New Feature Suggestion + url : https://features.azuracast.com + about : Submit an idea for a new feature via our FeatureUpvote site. - - name: Join AzuraCast Discord - url: https://www.azuracast.com/discord - about: Join the Discord community for help and support from other station owners. \ No newline at end of file + - name : Submit New Translations + url : https://translate.azuracast.com + about : Submit and manage translations for the AzuraCast application. + + - name : Join AzuraCast Discord + url : https://discord.gg/azuracast + about : Join the Discord community for help and support from other station owners. diff --git a/CHANGELOG.md b/CHANGELOG.md index a3eca7ae7..3dcb20eec 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -754,7 +754,7 @@ important updates to the software in that time, especially in the fields of reli the "Now Playing" API, which is a rich summary of the state of a radio station at the moment. To improve performance of more popular stations using our software, we've introduced two new methods of accessing this data: a static JSON file and a live Websocket/EventSource-driven plugin. You can read more on our - new [Now Playing Data APIs Guide](https://www.azuracast.com/developers/nowplaying.html). + new [Now Playing Data APIs Guide](https://docs.azuracast.com/en/developers/apis/now-playing-data). ## Bug Fixes and Minor Updates diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md index 23e2e1198..a5acb0ea6 100644 --- a/CODE_OF_CONDUCT.md +++ b/CODE_OF_CONDUCT.md @@ -4,4 +4,5 @@ All repositories in the AzuraCast organization adhere to the Contributor Covenan interactions across all media, including our GitHub issues and public social media channels, to adhere to these guidelines. -Visit [the AzuraCast web site](https://www.azuracast.com/code_of_conduct.html) for the full text of our Code of Conduct. +Visit [the AzuraCast web site](https://docs.azuracast.com/en/contribute/code-of-conduct) for the full text of our Code +of Conduct. diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 8717a2053..c44d11e9c 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,57 +1,87 @@ # Contributing to AzuraCast -As a free and open-source software project, we eagerly welcome contributions from the community. There are many ways to help contribute to AzuraCast's development, so you can make a difference without being a seasoned developer. +As a free and open-source software project, we eagerly welcome contributions from the community. There are many ways to +help contribute to AzuraCast's development, so you can make a difference without being a seasoned developer. ## Contributing Code Changes -AzuraCast is open-source software, and as part of this dedication to openness and transparency, we fully support contributions from members of the community who are skilled in the languages that we use to build our applications. +AzuraCast is open-source software, and as part of this dedication to openness and transparency, we fully support +contributions from members of the community who are skilled in the languages that we use to build our applications. -A majority of our repositories come with an `.editorconfig` file in the root, which will set many standards for indentation, punctuation and other style items for you automatically. You may need to enable EditorConfig support in your IDE of choice. +A majority of our repositories come with an `.editorconfig` file in the root, which will set many standards for +indentation, punctuation and other style items for you automatically. You may need to enable EditorConfig support in +your IDE of choice. -If your IDE does not support EditorConfig, the most important standard to remember that we follow is the PHP Framework Interoperability Group's [PSR-12 Extended Coding Style](https://www.php-fig.org/psr/psr-12/) standard. +If your IDE does not support EditorConfig, the most important standard to remember that we follow is the PHP Framework +Interoperability Group's [PSR-12 Extended Coding Style](https://www.php-fig.org/psr/psr-12/) standard. -Accessibility, security, and modern best practices are very important in AzuraCast's development. Any newly contributed code can, and should, take advantage of the full suite of new features made available in PHP 7.4 and newer. +Accessibility, security, and modern best practices are very important in AzuraCast's development. Any newly contributed +code can, and should, take advantage of the full suite of new features made available in PHP 7.4 and newer. -Instructions for developing with AzuraCast locally are [available here](https://www.azuracast.com/developers). If you have questions about the guidelines above or about how to contribute to AzuraCast, please create a Github issue, join our [Discord server.](https://www.azuracast.com/discord) Please note that support is offered on an 'as available' basis. +Instructions for developing with AzuraCast locally +are [available here](https://docs.azuracast.com/en/developers/getting-started). If you have questions about the +guidelines above or about how to contribute to AzuraCast, please create a Github issue, join +our [Discord server.](https://www.azuracast.com/discord) Please note that support is offered on an 'as available' basis. Contributions are also welcome in the supporting technologies used to make AzuraCast possible, such as: - - Dockerfiles (see [our separate repositories](https://github.com/AzuraCast) for Docker containers) - - [Ansible configuration](https://github.com/AzuraCast/AzuraCast/tree/main/util/ansible) for Ansible installs +- Dockerfiles (see [our separate repositories](https://github.com/AzuraCast) for Docker containers) +- [Ansible configuration](https://github.com/AzuraCast/AzuraCast/tree/main/util/ansible) for Ansible installs ## Translating AzuraCast Do you speak both English and another language? You can help us in a _big_ way by helping translate AzuraCast! -AzuraCast is used around the world, and we want our web application to be accessible to users who aren't familiar with English, our primary language. +AzuraCast is used around the world, and we want our web application to be accessible to users who aren't familiar with +English, our primary language. -Thanks to the help of our friends at CrowdIn, translating the strings used in our application is easy! Just [follow this invite link](https://crowdin.com/project/azuracast/invite) and create an account, and you can start submitting translations. CrowdIn also provides suggested translations in case you are unsure of certain words or phrases. +Thanks to the help of our friends at CrowdIn, translating the strings used in our application is easy! +Just [follow this invite link](https://crowdin.com/project/azuracast/invite) and create an account, and you can start +submitting translations. CrowdIn also provides suggested translations in case you are unsure of certain words or +phrases. -We do our best to incorporate translation changes as frequently as possible, but sometimes new updates are delayed. If you have completed a significant translation project, please feel free to give us a gentle reminder by creating a Github issue. Once the translations have been updated, we will close the issue to let you know. +We do our best to incorporate translation changes as frequently as possible, but sometimes new updates are delayed. If +you have completed a significant translation project, please feel free to give us a gentle reminder by creating a Github +issue. Once the translations have been updated, we will close the issue to let you know. ## Testing New Platforms -Getting a project as large and complex as AzuraCast to work on many platforms is a huge effort, and is often far too complex for a single-developer project such as this. +Getting a project as large and complex as AzuraCast to work on many platforms is a huge effort, and is often far too +complex for a single-developer project such as this. -Thankfully, we've adopted support for Docker, a tool that allows us to create prebuilt images with all of our software stack properly configured and arranged, which you can then run on just about any host that will run the latest version of Docker. It's portable, it's cross-platform, and pulling down new updates are far easier than before; for these reasons, we heavily emphasize using Docker over our older, Ubuntu-specific Ansible installation. +Thankfully, we've adopted support for Docker, a tool that allows us to create prebuilt images with all of our software +stack properly configured and arranged, which you can then run on just about any host that will run the latest version +of Docker. It's portable, it's cross-platform, and pulling down new updates are far easier than before; for these +reasons, we heavily emphasize using Docker over our older, Ubuntu-specific Ansible installation. -Although we use Docker in local development and on our testing and demonstration servers, sometimes a problem will occur that stops a particular host from working with our application. If you're a user affected by such an issue, we encourage you to advise us by creating a Github issue, especially if there is a known solution to the issue that we can apply. +Although we use Docker in local development and on our testing and demonstration servers, sometimes a problem will occur +that stops a particular host from working with our application. If you're a user affected by such an issue, we encourage +you to advise us by creating a Github issue, especially if there is a known solution to the issue that we can apply. ## The "Do Nots" of Contributing -While we appreciate everyone who is eager to contribute to this project and help it succeed, we must ask that some forms of interaction be avoided: +While we appreciate everyone who is eager to contribute to this project and help it succeed, we must ask that some forms +of interaction be avoided: - - Please **do not e-mail the project developer directly** with questions or issues specific to AzuraCast, unless you were specifically requested to do so as part of an ongoing issue. Contacting me directly prevents me from tracking all outstanding issues in one place, and harms the transparency that is essential to FOSS development. If, however, you are e-mailing me to offer me a paying job...go nuts. +- Please **do not e-mail the project developer directly** with questions or issues specific to AzuraCast, unless you + were specifically requested to do so as part of an ongoing issue. Contacting me directly prevents me from tracking all + outstanding issues in one place, and harms the transparency that is essential to FOSS development. If, however, you + are e-mailing me to offer me a paying job...go nuts. - - Please **do not create "this doesn't work" issues** that are just one sentence long and don't provide any insight into the scope of the issue, what changes might have triggered it, or what platform you're running on. At the very minimum, please fill out the template provided, as it gives us a lot of information to debug and provide you with support. +- Please **do not create "this doesn't work" issues** that are just one sentence long and don't provide any insight into + the scope of the issue, what changes might have triggered it, or what platform you're running on. At the very minimum, + please fill out the template provided, as it gives us a lot of information to debug and provide you with support. - - Please **refer to existing Github issues** if you are curious about the status of outstanding bug reports or new enhancement requests. Always remember that this is a volunteer project primarily built and maintained by a single developer, and manage your expectations accordingly. +- Please **refer to existing Github issues** if you are curious about the status of outstanding bug reports or new + enhancement requests. Always remember that this is a volunteer project primarily built and maintained by a single + developer, and manage your expectations accordingly. ## Support AzuraCast ### Support us on GitHub Sponsors -Donating through GitHub Sponsors is the best way to show your support for AzuraCast's development. You can change your pledge at any time through the Sponsors Page. GitHub will match every sponsor on our page so every donation counts. +Donating through GitHub Sponsors is the best way to show your support for AzuraCast's development. You can change your +pledge at any time through the Sponsors Page. GitHub will match every sponsor on our page so every donation counts. [GitHub Sponsor Page][sponsor] @@ -60,12 +90,14 @@ Donating through GitHub Sponsors is the best way to show your support for AzuraC ### Donate to our Patreon -Donating to AzuraCast's Patreon is a great way to show your ongoing support for the project's continual development and updates. You can edit your pledge or cancel at any time. +Donating to AzuraCast's Patreon is a great way to show your ongoing support for the project's continual development and +updates. You can edit your pledge or cancel at any time. ### Donate via Ko-Fi -If you'd like to make a one-time donation through PayPal, you can do so by buying our lead developer a coffee (or two!) via the Ko-Fi payment service. Every donation is greatly appreciated. +If you'd like to make a one-time donation through PayPal, you can do so by buying our lead developer a coffee (or two!) +via the Ko-Fi payment service. Every donation is greatly appreciated. Buy Me a Coffee at ko-fi.com diff --git a/README.md b/README.md index 043b7b406..f7f602020 100644 --- a/README.md +++ b/README.md @@ -8,50 +8,73 @@ [![Docker Pulls](https://img.shields.io/docker/pulls/azuracast/azuracast_radio.svg)](https://hub.docker.com/r/azuracast/azuracast_radio/) [![Twitter Follow](https://img.shields.io/twitter/follow/azuracast.svg?style=social&label=Follow)](https://twitter.com/azuracast) -**AzuraCast** is a self-hosted, all-in-one web radio management suite. Using its easy installer and powerful but intuitive web interface, you can start up a fully working web radio station in a few quick minutes. +**AzuraCast** is a self-hosted, all-in-one web radio management suite. Using its easy installer and powerful but +intuitive web interface, you can start up a fully working web radio station in a few quick minutes. ![](https://www.azuracast.com/img/ScreenshotTour.gif) -AzuraCast works for web radio stations of all types and sizes, and is built to run on even the most affordable VPS web hosts. AzuraCast's mascot is [Azura Ruisselante](https://www.azuracast.com/about/mascot.html), created by [Tyson Tan](https://tysontan.deviantart.com/). +AzuraCast works for web radio stations of all types and sizes, and is built to run on even the most affordable VPS web +hosts. AzuraCast's mascot is Azura Ruisselante, created by [Tyson Tan](https://tysontan.deviantart.com/). -**AzuraCast is currently in beta.** Many web radio stations already run AzuraCast, but keeping your server up-to-date with the latest code from the GitHub repository is strongly recommended for security, bug fixes and new feature releases. It's unlikely, but updates may result in unexpected issues or data loss, so always make sure to keep your station's media files backed up in a second location. +**AzuraCast is currently in beta.** Many web radio stations already run AzuraCast, but keeping your server up-to-date +with the latest code from the GitHub repository is strongly recommended for security, bug fixes and new feature +releases. It's unlikely, but updates may result in unexpected issues or data loss, so always make sure to keep your +station's media files backed up in a second location. -To install AzuraCast, you should have a basic understanding of the Linux shell terminal. Once installed, every aspect of your radio station can be managed via AzuraCast's web interface. +To install AzuraCast, you should have a basic understanding of the Linux shell terminal. Once installed, every aspect of +your radio station can be managed via AzuraCast's web interface. ## Live Demo -Want to see AzuraCast for yourself? Check out [screenshots](https://www.azuracast.com/about/screenshots.html) or visit -our demo site at [demo.azuracast.com](https://demo.azuracast.com/): +Want to see AzuraCast for yourself? Visit our demo site at [demo.azuracast.com](https://demo.azuracast.com/): * Username: `demo@azuracast.com` * Password: `demo` ## Install AzuraCast -Follow our **[installation guide](https://azuracast.com/install/)** for instructions on how to install AzuraCast on your own server. +Follow our **[installation guide](https://docs.azuracast.com/en/getting-started/installation)** for instructions on how +to install AzuraCast on your own server. ## Features #### For Radio Stations -- **Rich Media Management:** Upload songs, edit metadata, preview songs and organize music into folders from your browser. -- **Playlists:** Add music to standard-rotation playlists (in sequential or shuffled playback order) or schedule a playlist to play at a scheduled time, or once per x songs/minutes/etc. -- **Live DJs:** Set up individual DJ/streamer accounts and see who's currently streaming from your station's profile page. -- **Web DJ:** Broadcast live directly from your browser, with no extra software needed, with AzuraCast's built-in Web DJ tool. -- **Public Pages:** AzuraCast includes embeddable public pages that you can integrate into your existing web page or use as the basis for your own customized player. -- **Listener Requests:** Let your listeners request specific songs from your playlists, both via an API and a simple public-facing listener page. +- **Rich Media Management:** Upload songs, edit metadata, preview songs and organize music into folders from your + browser. +- **Playlists:** Add music to standard-rotation playlists (in sequential or shuffled playback order) or schedule a + playlist to play at a scheduled time, or once per x songs/minutes/etc. +- **Live DJs:** Set up individual DJ/streamer accounts and see who's currently streaming from your station's profile + page. +- **Web DJ:** Broadcast live directly from your browser, with no extra software needed, with AzuraCast's built-in Web DJ + tool. +- **Public Pages:** AzuraCast includes embeddable public pages that you can integrate into your existing web page or use + as the basis for your own customized player. +- **Listener Requests:** Let your listeners request specific songs from your playlists, both via an API and a simple + public-facing listener page. - **Remote Relays:** Broadcast your radio signal (including live DJs) to any remote server running Icecast or SHOUTcast. -- **Web Hooks:** Integrate your station with Slack, Discord, TuneIn, Twitter and more by setting up web hooks that connect to third-party services. -- **Detailed Analytics and Reports:** Keep track of every aspect of your station's listeners over time. View reports of each song's impact on your listener count. You can also generate a report that's compatible with SoundExchange for US web radio royalties. +- **Web Hooks:** Integrate your station with Slack, Discord, TuneIn, Twitter and more by setting up web hooks that + connect to third-party services. +- **Detailed Analytics and Reports:** Keep track of every aspect of your station's listeners over time. View reports of + each song's impact on your listener count. You can also generate a report that's compatible with SoundExchange for US + web radio royalties. #### For Server Administrators -- **Role-based User Management:** Assign global and per-station permissions to a role, then add users to those roles to control access. -- **Custom Branding:** Modify every aspect of both the internal and public-facing AzuraCast pages by supplying your own custom CSS and JavaScript. -- **Authenticated RESTful API:** Individual users in the system can create API keys which have the same permissions they have in the system. The AzuraCast API is a powerful and [well-documented](https://www.azuracast.com/api/index.html) tool for interacting with installations. -- **Web Log Viewing:** Quickly diagnose problems affecting any part of the AzuraCast system through the system-wide web log viewer. -- **Automatic Radio Proxies:** Many users can't connect directly to radio station ports (i.e. 8000) by default, so AzuraCast includes an automatic nginx proxy that lets listeners connect via the http (80) and https (443) ports. These proxies are also compatible with services like CloudFlare. -- **Storage Location Management:** Station media, live recordings and backups can be stored localy or on an S3 compatible storage provider. +- **Role-based User Management:** Assign global and per-station permissions to a role, then add users to those roles to + control access. +- **Custom Branding:** Modify every aspect of both the internal and public-facing AzuraCast pages by supplying your own + custom CSS and JavaScript. +- **Authenticated RESTful API:** Individual users in the system can create API keys which have the same permissions they + have in the system. The AzuraCast API is a powerful and [well-documented](https://www.azuracast.com/api/index.html) + tool for interacting with installations. +- **Web Log Viewing:** Quickly diagnose problems affecting any part of the AzuraCast system through the system-wide web + log viewer. +- **Automatic Radio Proxies:** Many users can't connect directly to radio station ports (i.e. 8000) by default, so + AzuraCast includes an automatic nginx proxy that lets listeners connect via the http (80) and https (443) ports. These + proxies are also compatible with services like CloudFlare. +- **Storage Location Management:** Station media, live recordings and backups can be stored localy or on an S3 + compatible storage provider. ### What's Included @@ -62,7 +85,9 @@ AzuraCast will automatically retrieve and install these components for you: * **[Liquidsoap](https://www.liquidsoap.info/)** as the always-playing "AutoDJ" * **[Icecast 2.4](https://icecast.org/)** as a radio broadcasting frontend (Icecast-KH installed on supported platforms) -For x86/x64 installations, [SHOUTcast 2 DNAS](http://wiki.shoutcast.com/wiki/SHOUTcast_DNAS_Server_2) can also be used as a broadcasting frontend. SHOUTcast is non-free software and does not come bundled with AzuraCast, but can be installed via the administration panel after AzuraCast has been installed. +For x86/x64 installations, [SHOUTcast 2 DNAS](http://wiki.shoutcast.com/wiki/SHOUTcast_DNAS_Server_2) can also be used +as a broadcasting frontend. SHOUTcast is non-free software and does not come bundled with AzuraCast, but can be +installed via the administration panel after AzuraCast has been installed. #### Supporting Software @@ -73,49 +98,76 @@ For x86/x64 installations, [SHOUTcast 2 DNAS](http://wiki.shoutcast.com/wiki/SHO ## AzuraCast API -Once installed and running, AzuraCast exposes an API that allows you to monitor and interact with your stations. Documentation about this API and its endpoints are available on the [AzuraCast API Documentation](https://www.azuracast.com/api/index.html). +Once installed and running, AzuraCast exposes an API that allows you to monitor and interact with your stations. +Documentation about this API and its endpoints are available on +the [AzuraCast API Documentation](https://www.azuracast.com/api/index.html). ## License -AzuraCast is licensed under the [Apache license, version 2.0](https://github.com/AzuraCast/AzuraCast/blob/main/LICENSE.txt). This project is free and open-source software, and pull requests are always welcome. +AzuraCast is licensed under +the [Apache license, version 2.0](https://github.com/AzuraCast/AzuraCast/blob/main/LICENSE.txt). This project is free +and open-source software, and pull requests are always welcome. ## Need Help? -If you need help with AzuraCast, the first place you should visit is our [Support page](https://www.azuracast.com/help/), which features solutions to a number of commonly encountered issues and questions, as well as instructions on how to check your server's log files for more details. If you do need our help via GitHub, supplying these logs is absolutely essential in helping us diagnose and resolve your issue. +If you need help with AzuraCast, the first place you should visit is +our [Support page](https://docs.azuracast.com/en/user-guide/troubleshooting) +, which features solutions to a number of commonly encountered issues and questions, as well as instructions on how to +check your server's log files for more details. If you do need our help via GitHub, supplying these logs is absolutely +essential in helping us diagnose and resolve your issue. -New feature requests are powered by FeatureUpvote. You can visit our [Feature Request Page](https://features.azuracast.com/) to submit a new feature request or vote on existing ones. +New feature requests are powered by FeatureUpvote. You can visit +our [Feature Request Page](https://features.azuracast.com/) to submit a new feature request or vote on existing ones. -For bug and error reports, we rely exclusively on our [GitHub Issues board](https://github.com/AzuraCast/AzuraCast/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) to diagnose, track and update these reports. First, check to make sure the issue you're experiencing isn't already reported on GitHub. If it is, you can subscribe to the existing ticket for updates on the issue's progress. If your issue or request isn't already reported, click the "New Issue" button to create it. Make sure to follow the template provided, as it asks important details that are very important to our team. +For bug and error reports, we rely exclusively on +our [GitHub Issues board](https://github.com/AzuraCast/AzuraCast/issues?q=is%3Aissue+is%3Aopen+sort%3Aupdated-desc) to +diagnose, track and update these reports. First, check to make sure the issue you're experiencing isn't already reported +on GitHub. If it is, you can subscribe to the existing ticket for updates on the issue's progress. If your issue or +request isn't already reported, click the "New Issue" button to create it. Make sure to follow the template provided, as +it asks important details that are very important to our team. -Please keep in mind that AzuraCast is a free software project built and maintained by volunteers, so there may be some delays in getting back to you. We will make the absolute best effort possible to resolve your issues and answer your questions. +Please keep in mind that AzuraCast is a free software project built and maintained by volunteers, so there may be some +delays in getting back to you. We will make the absolute best effort possible to resolve your issues and answer your +questions. ## Communities and Social Media -We frequently post to social media any time there are significant updates to our software, security issues that users should be aware of, or upcoming changes to third-party software. You can get these updates in a more timely fashion by following our accounts: +We frequently post to social media any time there are significant updates to our software, security issues that users +should be aware of, or upcoming changes to third-party software. You can get these updates in a more timely fashion by +following our accounts: - On Twitter at [@AzuraCast](https://twitter.com/azuracast), or - On Mastodon at [@AzuraCast@fosstodon.org](https://fosstodon.org/@AzuraCast) -If you are an AzuraCast user, station owner, developer or other contributor, you can also join our Discord community, where you can ask questions, share your station and more: +If you are an AzuraCast user, station owner, developer or other contributor, you can also join our Discord community, +where you can ask questions, share your station and more: -- [Discord](https://azuracast.com/discord) +- [Discord](https://discord.gg/azuracast) -Note that our social media channels aren't the best way to report issues to us; instead, you should use the GitHub issues instructions above, as this allows our whole team to help resolve and track the progress of the issue in one location. +Note that our social media channels aren't the best way to report issues to us; instead, you should use the GitHub +issues instructions above, as this allows our whole team to help resolve and track the progress of the issue in one +location. ## Friends of AzuraCast We would like to thank the following organizations for their support of AzuraCast's ongoing development: -- [DigitalOcean](https://m.do.co/c/21612b90440f) for generously providing the server resources we use for our demonstration instance, our staging and testing environments, and more -- [JetBrains](https://www.jetbrains.com/) for making our development faster, easier and more productive with tools like PhpStorm -- [CrowdIn](https://crowdin.com/) for giving us a simple and powerful tool to help translate our application for users around the world -- [Netlify](https://www.netlify.com/) for supporting open-source software like ours and for serving as the host of our primary [azuracast.com](https://www.azuracast.com/) web site. +- [DigitalOcean](https://m.do.co/c/21612b90440f) for generously providing the server resources we use for our + demonstration instance, our staging and testing environments, and more +- [JetBrains](https://www.jetbrains.com/) for making our development faster, easier and more productive with tools like + PhpStorm +- [CrowdIn](https://crowdin.com/) for giving us a simple and powerful tool to help translate our application for users + around the world +- [Netlify](https://www.netlify.com/) for supporting open-source software like ours and for serving as the host of our + primary [azuracast.com](https://www.azuracast.com/) web site. -- The creators and maintainers of the many free and open-source tools that AzuraCast is built on, who have done so much to help move FOSS forward +- The creators and maintainers of the many free and open-source tools that AzuraCast is built on, who have done so much + to help move FOSS forward ## Support AzuraCast Development -AzuraCast will always be available free of charge, but if you find the software useful and would like to support the project's lead developer, visit either of the links below. Your support is greatly appreciated. +AzuraCast will always be available free of charge, but if you find the software useful and would like to support the +project's lead developer, visit either of the links below. Your support is greatly appreciated. Buy Me a Coffee at ko-fi.com diff --git a/SUPPORT.md b/SUPPORT.md index 043649991..ecbd18a00 100644 --- a/SUPPORT.md +++ b/SUPPORT.md @@ -1,5 +1,6 @@ # Support for AzuraCast -We've centralized all of our help and common support issues to a single location on our homepage. Click the link below for more information. +We've centralized all of our help and common support issues to a single location on our homepage. Click the link below +for more information. - - [AzuraCast Help Page](https://www.azuracast.com/help/) +- [AzuraCast Help Page](https://docs.azuracast.com/en/user-guide/troubleshooting) diff --git a/config/forms/settings.php b/config/forms/settings.php index 2a74045e5..89e8aa463 100644 --- a/config/forms/settings.php +++ b/config/forms/settings.php @@ -207,7 +207,7 @@ return [ 'markup' => '' . $releaseChannelName . '', 'description' => __( 'For information on how to switch your release channel, visit this page.', - 'https://www.azuracast.com/administration/system/release-channels.html' + 'https://docs.azuracast.com/en/getting-started/updates/release-channels' ), ], ], diff --git a/docker-compose.sample.yml b/docker-compose.sample.yml index 1ca9d4a07..d2d13f537 100644 --- a/docker-compose.sample.yml +++ b/docker-compose.sample.yml @@ -49,7 +49,7 @@ services : container_name : azuracast_web image : "azuracast/azuracast_web_v2:${AZURACAST_VERSION:-latest}" # Want to customize the HTTP/S ports? Follow the instructions here: - # https://www.azuracast.com/help/docker/#use-non-standard-ports + # https://docs.azuracast.com/en/administration/docker#using-non-standard-ports ports : - '${AZURACAST_SFTP_PORT:-2022}:2022' depends_on : @@ -117,7 +117,7 @@ services : # This default mapping is the outgoing and incoming ports for the first 50 stations. # You can override this port mapping in your own docker-compose.override.yml file. # For instructions, see: - # https://www.azuracast.com/help/docker/#expand-the-docker-radio-station-port-range + # https://docs.azuracast.com/en/administration/docker#expanding-the-station-port-range - '8000:8000' - '8005:8005' - '8006:8006' diff --git a/frontend/vue/station_playlists/form/PlaylistFormBasicInfo.vue b/frontend/vue/station_playlists/form/PlaylistFormBasicInfo.vue index b913ac3f9..9a95666f0 100644 --- a/frontend/vue/station_playlists/form/PlaylistFormBasicInfo.vue +++ b/frontend/vue/station_playlists/form/PlaylistFormBasicInfo.vue @@ -79,7 +79,7 @@ Advanced Manually define how this playlist is used in Liquidsoap configuration. - + Learn about Advanced Playlists diff --git a/src/Version.php b/src/Version.php index c2b28b970..f30768bb8 100644 --- a/src/Version.php +++ b/src/Version.php @@ -22,7 +22,7 @@ class Version public const LATEST_COMPOSE_REVISION = 11; public const LATEST_COMPOSE_URL = 'https://raw.githubusercontent.com/AzuraCast/AzuraCast/main/docker-compose.sample.yml'; - public const UPDATE_URL = 'https://www.azuracast.com/administration/system/updating.html'; + public const UPDATE_URL = 'https://docs.azuracast.com/en/getting-started/updates'; public const CHANGELOG_URL = 'https://github.com/AzuraCast/AzuraCast/blob/main/CHANGELOG.md'; // phpcs:enable diff --git a/templates/frontend/account/login.phtml b/templates/frontend/account/login.phtml index f339f38ff..4e10371ff 100644 --- a/templates/frontend/account/login.phtml +++ b/templates/frontend/account/login.phtml @@ -1,8 +1,12 @@ layout('minimal', [ - 'title' => __('Log In'), - 'page_class' => 'login-content', -]); + +$this->layout( + 'minimal', + [ + 'title' => __('Log In'), + 'page_class' => 'login-content', + ] +); ?>
@@ -11,16 +15,21 @@ $this->layout('minimal', [

- hideProductName()): ?> + hideProductName()): ?> - + getAppName())?> - +

- getInstanceName())): ?> + getInstanceName())): ?> e($customization->getInstanceName())?> - +

@@ -31,14 +40,18 @@ $this->layout('minimal', [ - +
- +
@@ -48,13 +61,17 @@ $this->layout('minimal', [
- -

Forgot your password?'), - 'https://www.azuracast.com/help/docker/#reset-an-account-password')?>

+

Forgot your password?'), + 'https://docs.azuracast.com/en/administration/users#resetting-an-account-password' + )?>

diff --git a/templates/main.phtml b/templates/main.phtml index 281398904..46f56ca02 100644 --- a/templates/main.phtml +++ b/templates/main.phtml @@ -106,7 +106,7 @@ endif; ?>">
  • - + @@ -185,7 +185,7 @@ endif; ?> role="contentinfo">
    Donate to support AzuraCast!', - 'https://www.azuracast.com/donate.html' + 'https://docs.azuracast.com/en/contribute/donate' )?> diff --git a/templates/minimal.phtml b/templates/minimal.phtml index 2cf0715f2..a23bb1efd 100644 --- a/templates/minimal.phtml +++ b/templates/minimal.phtml @@ -43,16 +43,19 @@ $page_class .= ' theme-' . $customization->getPublicTheme(); section('content')?> -hideProductName() && !$hide_footer): ?> +hideProductName() && !$hide_footer): ?>
    - ' . $environment->getAppName() . '' . ' ')?>
    - Tyson Tan')?> + ' . $environment->getAppName() . '' . ' ' + )?>
    - + -hasMessages()): ?> +hasMessages()): ?> - + diff --git a/templates/partials/log_help_card.phtml b/templates/partials/log_help_card.phtml index 66ce2e3e6..ca13e988d 100644 --- a/templates/partials/log_help_card.phtml +++ b/templates/partials/log_help_card.phtml @@ -3,13 +3,17 @@

    -

    support documents.', - 'https://www.azuracast.com/help/')?>

    +

    support documents.', + 'https://docs.azuracast.com/en/user-guide/troubleshooting' + )?>

    -

    %s. Be sure to include this when creating a new issue.', - ($environment->isDocker() ? 'Docker' : 'Ansible'))?>

    +

    %s. Be sure to include this when creating a new issue.', + ($environment->isDocker() ? 'Docker' : 'Ansible') + )?>

    diff --git a/templates/stations/streamers/index.phtml b/templates/stations/streamers/index.phtml index 4f4fa1428..646d9d597 100644 --- a/templates/stations/streamers/index.phtml +++ b/templates/stations/streamers/index.phtml @@ -1,11 +1,17 @@ layout('main', ['title' => __('Streamer/DJ Accounts'), 'manual' => true]); /** @var \App\Assets $assets */ $assets->load('StationStreamers') - ->addInlineJs($this->fetch('stations/streamers/index.js', [ - 'station_tz' => $station_tz, - ])); + ->addInlineJs( + $this->fetch( + 'stations/streamers/index.js', + [ + 'station_tz' => $station_tz, + ] + ) + ); ?>
    @@ -22,10 +28,14 @@ $assets->load('StationStreamers')
    :
    e($server_url)?>
    - -
    %s.', - $ip)?>
    - + +
    %s.', + $ip + )?>
    +
    :
    @@ -38,10 +48,14 @@ $assets->load('StationStreamers')
    :
    e($server_url)?>
    - -
    %s.', - $ip)?>
    - + +
    %s.', + $ip + )?>
    +
    :
    @@ -55,8 +69,12 @@ $assets->load('StationStreamers')
    -

    on the AzuraCast Wiki.'), - 'https://www.azuracast.com/station-management/djs/streaming_software.html')?>

    +

    on the AzuraCast Wiki.' + ), + 'https://docs.azuracast.com/en/user-guide/streaming-software' + )?>