diff --git a/.copier-answers.yaml b/.copier-answers.yaml index 04b5374..761bdd9 100644 --- a/.copier-answers.yaml +++ b/.copier-answers.yaml @@ -1,14 +1,14 @@ # Changes here will be overwritten by Copier; NEVER EDIT MANUALLY -_commit: 0.5.0 -_src_path: gh:radio-aktywne/template-app-liquidsoap +_commit: 0.6.0 +_src_path: gh:radio-aktywne/template-service-liquidsoap accountname: radio-aktywne -appname: emifuse -description: Audio streaming with Liquidsoap ๐Ÿงผ +description: Broadcast composing ๐Ÿงผ docs: true -docsurl: https://radio-aktywne.github.io/app-emifuse +docsurl: https://radio-aktywne.github.io/emifuse envprefix: EMIFUSE -imagename: apps/emifuse +imagename: services/emifuse registry: true releases: true -reponame: app-emifuse -repourl: https://github.com/radio-aktywne/app-emifuse +reponame: emifuse +repourl: https://github.com/radio-aktywne/emifuse +servicename: emifuse diff --git a/.devcontainer/devcontainer.json b/.devcontainer/devcontainer.json index 93ef16e..0437a99 100644 --- a/.devcontainer/devcontainer.json +++ b/.devcontainer/devcontainer.json @@ -1,6 +1,6 @@ { // Use latest pre-built image - "image": "ghcr.io/radio-aktywne/devcontainers/app-liquidsoap:latest", + "image": "ghcr.io/radio-aktywne/devcontainers/service-liquidsoap:latest", // Run arguments "runArgs": [ // Use host UTS namespace diff --git a/.github/workflows/registry.yaml b/.github/workflows/registry.yaml index 5cb0195..64f5d0c 100644 --- a/.github/workflows/registry.yaml +++ b/.github/workflows/registry.yaml @@ -39,9 +39,9 @@ jobs: push: true # Slashes are here to make the string multiline and avoid using spaces tags: "\ - ghcr.io/radio-aktywne/apps/emifuse\ + ghcr.io/radio-aktywne/services/emifuse\ :latest,\ - ghcr.io/radio-aktywne/apps/emifuse\ + ghcr.io/radio-aktywne/services/emifuse\ :${{ github.event.release.tag_name }}" # Cache Docker layers between builds cache-from: type=gha,scope=${{ github.workflow }} diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e89a878..48e0d73 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -11,13 +11,13 @@ The whole development environment will be running inside a container. If you open the project in `Visual Studio Code`, you should be prompted to reopen the project in a `Dev Container`. You can also click -[here](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/radio-aktywne/app-emifuse) +[here](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/radio-aktywne/emifuse) or on the badge below to tell `Visual Studio Code` to open the project in a `Dev Container`.
-[![Open in Dev Container](https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/radio-aktywne/app-emifuse) +[![Open in Dev Container](https://img.shields.io/static/v1?label=Dev%20Containers&message=Open&color=blue&logo=visualstudiocode)](https://vscode.dev/redirect?url=vscode://ms-vscode-remote.remote-containers/cloneInVolume?url=https://github.com/radio-aktywne/emifuse)
@@ -100,7 +100,7 @@ Here are the most common ones, using `Task`: Linting is automatically run on every pull request and push to the `main` branch. You can find the `GitHub Actions` workflow that does this in -[`.github/workflows/lint.yaml`](https://github.com/radio-aktywne/app-emifuse/blob/main/.github/workflows/lint.yaml). +[`.github/workflows/lint.yaml`](https://github.com/radio-aktywne/emifuse/blob/main/.github/workflows/lint.yaml). If you use the `Dev Container` setup, you will have the `Trunk` extension installed in `Visual Studio Code`. @@ -109,7 +109,7 @@ so you can format with it by using any editor formatting features. ## โ–ถ๏ธ Running -To run the application, you can use the following command: +To run the service, you can use the following command: ```sh task run @@ -117,7 +117,7 @@ task run ## ๐Ÿ‹ `Docker` -You can also run the application in a [`Docker`](https://www.docker.com) container. +You can also run the service in a [`Docker`](https://www.docker.com) container. To do this, just run the following command: @@ -125,7 +125,7 @@ To do this, just run the following command: task docker ``` -This will build a `Docker` image and run the application in a container. +This will build a `Docker` image and run the service in a container. ## ๐Ÿ“ฆ Releases @@ -133,13 +133,13 @@ Every time you create a new release on `GitHub`, a `GitHub Actions` workflow will automatically build and publish a new `Docker` image to the `GitHub Container Registry`. You can find the `GitHub Actions` workflow that does this in -[`.github/workflows/registry.yaml`](https://github.com/radio-aktywne/app-emifuse/blob/main/.github/workflows/registry.yaml). +[`.github/workflows/registry.yaml`](https://github.com/radio-aktywne/emifuse/blob/main/.github/workflows/registry.yaml). ## ๐Ÿ“„ Docs This project uses [`Docusaurus`](https://docusaurus.io) to generate documentation. The documentation is hosted on `GitHub Pages` and can be found -[here](https://radio-aktywne.github.io/app-emifuse). +[here](https://radio-aktywne.github.io/emifuse). All the documentation files are located in the `docs` directory. To build and serve the documentation locally, @@ -154,4 +154,4 @@ This will start a local server that will serve the documentation. The documentation is automatically built and deployed to `GitHub Pages` whenever a commit is pushed to the `main` branch. You can find the `GitHub Actions` workflow that does this in -[`.github/workflows/docs.yaml`](https://github.com/radio-aktywne/app-emifuse/blob/main/.github/workflows/docs.yaml). +[`.github/workflows/docs.yaml`](https://github.com/radio-aktywne/emifuse/blob/main/.github/workflows/docs.yaml). diff --git a/Dockerfile b/Dockerfile index c364660..05c85f8 100644 --- a/Dockerfile +++ b/Dockerfile @@ -32,15 +32,15 @@ COPY --from=env /env/build/closure/ /nix/store/ COPY --from=env /env/build/activate /env/activate # Set working directory to something other than root -WORKDIR /app/ +WORKDIR /service/ -# Create app user and data directory -RUN useradd --create-home app && \ +# Create service user and data directory +RUN useradd --create-home service && \ mkdir --parents data/ # Setup entrypoint for RUN commands COPY scripts/shell.sh scripts/shell.sh -SHELL ["/app/scripts/shell.sh"] +SHELL ["/service/scripts/shell.sh"] # Copy OpenAPI schema COPY openapi/ openapi/ @@ -50,8 +50,8 @@ COPY src/ src/ # Setup main entrypoint COPY scripts/entrypoint.sh scripts/entrypoint.sh -ENTRYPOINT ["/app/scripts/entrypoint.sh", "liquidsoap", "src/main.liq"] +ENTRYPOINT ["/service/scripts/entrypoint.sh", "liquidsoap", "src/main.liq"] CMD [] # Setup ownership -RUN chown --recursive app: ./ +RUN chown --recursive service: ./ diff --git a/README.md b/README.md index 97ecc50..5cf4e93 100644 --- a/README.md +++ b/README.md @@ -1,13 +1,13 @@ -

emifuse app

+

emifuse

-Audio streaming with Liquidsoap ๐Ÿงผ +Broadcast composing ๐Ÿงผ -[![Lint](https://github.com/radio-aktywne/app-emifuse/actions/workflows/lint.yaml/badge.svg)](https://github.com/radio-aktywne/app-emifuse/actions/workflows/lint.yaml) -[![Image](https://github.com/radio-aktywne/app-emifuse/actions/workflows/image.yaml/badge.svg)](https://github.com/radio-aktywne/app-emifuse/actions/workflows/image.yaml) -[![Registry](https://github.com/radio-aktywne/app-emifuse/actions/workflows/registry.yaml/badge.svg)](https://github.com/radio-aktywne/app-emifuse/actions/workflows/registry.yaml) -[![Docs](https://github.com/radio-aktywne/app-emifuse/actions/workflows/docs.yaml/badge.svg)](https://github.com/radio-aktywne/app-emifuse/actions/workflows/docs.yaml) +[![Lint](https://github.com/radio-aktywne/emifuse/actions/workflows/lint.yaml/badge.svg)](https://github.com/radio-aktywne/emifuse/actions/workflows/lint.yaml) +[![Image](https://github.com/radio-aktywne/emifuse/actions/workflows/image.yaml/badge.svg)](https://github.com/radio-aktywne/emifuse/actions/workflows/image.yaml) +[![Registry](https://github.com/radio-aktywne/emifuse/actions/workflows/registry.yaml/badge.svg)](https://github.com/radio-aktywne/emifuse/actions/workflows/registry.yaml) +[![Docs](https://github.com/radio-aktywne/emifuse/actions/workflows/docs.yaml/badge.svg)](https://github.com/radio-aktywne/emifuse/actions/workflows/docs.yaml)
@@ -16,15 +16,14 @@ Audio streaming with Liquidsoap ๐Ÿงผ ## ๐Ÿ’ก About `emifuse` is a [`Liquidsoap`](https://www.liquidsoap.info) -server that fuses music from playlists and live audio -and sends one output stream to broadcast servers. +service for composing broadcast streams. ## ๐Ÿ“„ Further Reading More in-depth documentation can be found -[here](https://radio-aktywne.github.io/app-emifuse). +[here](https://radio-aktywne.github.io/emifuse). ## ๐Ÿ’ป Development Read more about how to develop the project -[here](https://github.com/radio-aktywne/app-emifuse/blob/main/CONTRIBUTING.md). +[here](https://github.com/radio-aktywne/emifuse/blob/main/CONTRIBUTING.md). diff --git a/Taskfile.dist.yaml b/Taskfile.dist.yaml index 8fe7d0b..c47fbe2 100644 --- a/Taskfile.dist.yaml +++ b/Taskfile.dist.yaml @@ -122,7 +122,7 @@ tasks: docs {{ .CLI_ARGS | default "start --host 0.0.0.0" }} run: - desc: Run the app + desc: Run the service interactive: true cmds: - > diff --git a/docker-compose.yaml b/docker-compose.yaml index 88943c6..71d8ab7 100644 --- a/docker-compose.yaml +++ b/docker-compose.yaml @@ -19,7 +19,7 @@ services: - "EMIFUSE__EMITUNES__HTTP__PATH=${EMIFUSE__EMITUNES__HTTP__PATH:-}" network_mode: host volumes: - - data:/app/data/ + - data:/service/data/ volumes: data: {} diff --git a/docs/docs/01-Index.md b/docs/docs/01-Index.md index 9127e58..f869b7a 100644 --- a/docs/docs/01-Index.md +++ b/docs/docs/01-Index.md @@ -3,12 +3,11 @@ slug: / title: Index --- -# emifuse app +# emifuse -Audio streaming with Liquidsoap ๐Ÿงผ +Broadcast composing ๐Ÿงผ ## ๐Ÿ’ก About `emifuse` is a [`Liquidsoap`](https://www.liquidsoap.info) -server that fuses music from playlists and live audio -and sends one output stream to broadcast servers. +service for composing broadcast streams. diff --git a/docs/docs/03-Configuration.md b/docs/docs/03-Configuration.md index 5db0a9a..db1ad6b 100644 --- a/docs/docs/03-Configuration.md +++ b/docs/docs/03-Configuration.md @@ -5,7 +5,7 @@ title: Configuration ## Environment variables -You can configure the app at runtime using various environment variables: +You can configure the service at runtime using various environment variables: - `EMIFUSE__SERVER__SRT__PORT` port to listen for SRT connections diff --git a/docs/docusaurus.config.mts b/docs/docusaurus.config.mts index 99dfea1..d730bbb 100644 --- a/docs/docusaurus.config.mts +++ b/docs/docusaurus.config.mts @@ -2,10 +2,10 @@ import type * as Preset from "@docusaurus/preset-classic"; import type { Config } from "@docusaurus/types"; import { themes } from "prism-react-renderer"; -const url = new URL("https://radio-aktywne.github.io/app-emifuse"); +const url = new URL("https://radio-aktywne.github.io/emifuse"); const config: Config = { - title: "emifusee app docs", + title: "emifusee docs", favicon: "favicon.svg?v=1", url: `${url.protocol}//${url.host}`, @@ -41,14 +41,14 @@ const config: Config = { themeConfig: { navbar: { - title: "emifusee app docs", + title: "emifusee docs", logo: { - alt: "emifusee app docs logo", + alt: "emifusee docs logo", src: "logo.svg?v=1", }, items: [ { - href: "https://github.com/radio-aktywne/app-emifusee", + href: "https://github.com/radio-aktywne/emifusee", position: "right", className: "header-github-link", "aria-label": "GitHub repository", diff --git a/openapi/schema.yaml b/openapi/schema.yaml index c0f7731..1e8aacf 100644 --- a/openapi/schema.yaml +++ b/openapi/schema.yaml @@ -1,6 +1,6 @@ info: - title: emifuse app - description: Audio streaming with Liquidsoap ๐Ÿงผ + title: emifuse + description: Broadcast composing ๐Ÿงผ openapi: 3.1.0 servers: - url: / diff --git a/scripts/entrypoint.sh b/scripts/entrypoint.sh index bed5d24..e2f3a25 100755 --- a/scripts/entrypoint.sh +++ b/scripts/entrypoint.sh @@ -5,8 +5,8 @@ . /env/activate # Set permissions -chown --recursive app: data/ +chown --recursive service: data/ # Run as non-root user # Use tini to handle signals -exec su-exec app tini -- "$@" +exec su-exec service tini -- "$@"