From 32cb16038e753dcf81083da208668c898da5609d Mon Sep 17 00:00:00 2001 From: Buster Neece Date: Tue, 10 Oct 2023 15:51:18 -0500 Subject: [PATCH] Implement built-in docs, update settings and URLs across the app. --- CHANGELOG.md | 10 +- Dockerfile | 3 + README.md | 15 +- config/routes/api.php | 2 +- docker-compose.sample.yml | 6 +- .../components/Admin/Settings/ServicesTab.vue | 2 +- frontend/src/components/Admin/Updates.vue | 4 +- frontend/src/components/PanelLayout.vue | 18 +- frontend/src/components/Stations/Logs.vue | 2 +- .../Stations/Playlists/Form/BasicInfo.vue | 2 +- .../Stations/Streamers/ConnectionInfo.vue | 2 +- src/Notification/Check/UpdateCheck.php | 2 +- .../frontend/account/forgot_disabled.phtml | 2 +- util/docker/docs/setup.sh | 18 + util/docker/web/nginx/azuracast.conf.tmpl | 6 + web/static/api/favicon-16x16.png | Bin 665 -> 0 bytes web/static/api/favicon-32x32.png | Bin 628 -> 0 bytes web/static/api/index.html | 60 - web/static/api/oauth2-redirect.html | 75 - web/static/api/openapi.yml | 5180 ----------------- web/static/api/swagger-ui-bundle.js | 3 - web/static/api/swagger-ui-es-bundle-core.js | 3 - web/static/api/swagger-ui-es-bundle.js | 3 - .../api/swagger-ui-standalone-preset.js | 3 - web/static/api/swagger-ui.css | 4 - web/static/api/swagger-ui.js | 3 - 26 files changed, 68 insertions(+), 5360 deletions(-) create mode 100644 util/docker/docs/setup.sh delete mode 100644 web/static/api/favicon-16x16.png delete mode 100644 web/static/api/favicon-32x32.png delete mode 100644 web/static/api/index.html delete mode 100644 web/static/api/oauth2-redirect.html delete mode 100644 web/static/api/openapi.yml delete mode 100644 web/static/api/swagger-ui-bundle.js delete mode 100644 web/static/api/swagger-ui-es-bundle-core.js delete mode 100644 web/static/api/swagger-ui-es-bundle.js delete mode 100644 web/static/api/swagger-ui-standalone-preset.js delete mode 100644 web/static/api/swagger-ui.css delete mode 100644 web/static/api/swagger-ui.js diff --git a/CHANGELOG.md b/CHANGELOG.md index 7a917b9e5..974c1f31d 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -5,6 +5,10 @@ release channel, you can take advantage of these new features and fixes. ## New Features/Changes +- **Built-in Documentation**: AzuraCast now bundles its own documentation alongside the application itself. By + visiting `/docs`, you can see the documentation as it existed when the version you're using was released. This is + useful if you're on an older version or in an environment without good Internet connectivity. + - The "Listeners by Time Period" report has been expanded to include showing either "Average Listeners" (the previous mode) or "Unique Listeners", similar to the dashboard charts. You can also view per-hour totals for every given day of the week. @@ -321,7 +325,7 @@ multi-tenant installations (i.e. resellers). Upgrading is strongly recommended i high-performance (Websocket/SSE) Now Playing updates system due to an error in the library on Ubuntu 22.04. We have since found an excellent replacement library and implemented it. If you're using Websockets or Server-Sent Events ( SSE) for your Now Playing updates, you'll need to make minor changes to how you connect, which we've documented - here: https://docs.azuracast.com/en/developers/apis/now-playing-data#high-performance-updates + here: https://www.azuracast.com/docs/developers/now-playing-data/#high-performance-updates - On Mastodon and Twitter posts, you can now specify different message bodies for the different web hook trigger types ( i.e. live DJ connect/disconnect or station online/offline). @@ -760,7 +764,7 @@ multi-tenant installations (i.e. resellers). Upgrading is strongly recommended i installation with fewer containers. If you are not using the multi-site setup (i.e. hosting another site on the same Docker installation), no changes are required to your installation. If you want to continue using the multi-site installation, you can follow - the [instructions in our documentation](https://docs.azuracast.com/en/administration/docker/multi-site-installation). + the [instructions in our documentation](https://www.azuracast.com/docs/administration/multi-site-installation/). - We have updated how we handle Listener Reports to significantly reduce both memory and overall processing times, meaning stations with large listener counts can now more easily view and export reports for long time periods. @@ -1965,7 +1969,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://docs.azuracast.com/en/developers/apis/now-playing-data). + new [Now Playing Data APIs Guide](https://www.azuracast.com/docs/developers/now-playing-data/). ## Bug Fixes and Minor Updates diff --git a/Dockerfile b/Dockerfile index 712143aeb..e460c766f 100644 --- a/Dockerfile +++ b/Dockerfile @@ -55,6 +55,9 @@ RUN bash /bd_build/mariadb/setup.sh COPY ./util/docker/redis /bd_build/redis/ RUN bash /bd_build/redis/setup.sh +COPY ./util/docker/docs /bd_build/docs/ +RUN bash /bd_build/docs/setup.sh + RUN bash /bd_build/cleanup.sh \ && rm -rf /bd_build diff --git a/README.md b/README.md index 91813a293..561e7c0c9 100644 --- a/README.md +++ b/README.md @@ -17,12 +17,12 @@ currently beta software. ![](https://www.azuracast.com/img/ScreenshotTour.gif) -You can learn more about AzuraCast via our [Documentation](https://docs.azuracast.com/): +You can learn more about AzuraCast via our [Documentation](https://www.azuracast.com/docs): -- [About AzuraCast](https://docs.azuracast.com/en/home#core-features) -- [Included Software](https://docs.azuracast.com/en/home#whats-included) -- [System Requirements](https://docs.azuracast.com/en/getting-started/requirements) -- [Installation](https://docs.azuracast.com/en/getting-started/installation) +- [About AzuraCast](https://www.azuracast.com/docs/#core-features) +- [Included Software](https://www.azuracast.com/docs/#whats-included) +- [System Requirements](https://www.azuracast.com/docs/getting-started/requirements/) +- [Installation](https://www.azuracast.com/docs/getting-started/installation/) ## Live Demo @@ -36,7 +36,8 @@ Want to see AzuraCast for yourself? Visit our demo site at [demo.azuracast.com]( 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. -Follow our **[installation guide](https://docs.azuracast.com/en/getting-started/installation)** for instructions on how +Follow our **[installation guide](https://www.azuracast.com/docs/getting-started/installation/)** for instructions on +how to install AzuraCast on your own server. ## License @@ -49,7 +50,7 @@ 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://docs.azuracast.com/en/user-guide/troubleshooting) +our [Support page](https://www.azuracast.com/docs/help/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. diff --git a/config/routes/api.php b/config/routes/api.php index b2d8cf76c..318fb2db9 100644 --- a/config/routes/api.php +++ b/config/routes/api.php @@ -29,7 +29,7 @@ return static function (RouteCollectorProxy $app) { $group->get( '', function (ServerRequest $request, Response $response, ...$params): ResponseInterface { - return $response->withRedirect('/static/api/index.html'); + return $response->withRedirect('/docs/api/'); } )->setName('api:index:index'); diff --git a/docker-compose.sample.yml b/docker-compose.sample.yml index c5e10c068..7d5093424 100644 --- a/docker-compose.sample.yml +++ b/docker-compose.sample.yml @@ -17,15 +17,11 @@ services: labels: - "com.centurylinklabs.watchtower.scope=azuracast" # Want to customize the HTTP/S ports? Follow the instructions here: - # https://docs.azuracast.com/en/administration/docker#using-non-standard-ports + # https://www.azuracast.com/docs/administration/docker/#using-non-standard-ports ports: - '${AZURACAST_HTTP_PORT:-80}:80' - '${AZURACAST_HTTPS_PORT:-443}:443' - '${AZURACAST_SFTP_PORT:-2022}:2022' - # 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://docs.azuracast.com/en/administration/docker#expanding-the-station-port-range - '8000:8000' - '8005:8005' - '8006:8006' diff --git a/frontend/src/components/Admin/Settings/ServicesTab.vue b/frontend/src/components/Admin/Settings/ServicesTab.vue index 5901eb507..03020d4bf 100644 --- a/frontend/src/components/Admin/Settings/ServicesTab.vue +++ b/frontend/src/components/Admin/Settings/ServicesTab.vue @@ -16,7 +16,7 @@ >