Skip to content

Commit

Permalink
spelling and rearrange readme
Browse files Browse the repository at this point in the history
  • Loading branch information
lachlan-00 committed Jul 18, 2024
1 parent d10aa5c commit f151cba
Show file tree
Hide file tree
Showing 6 changed files with 18 additions and 31 deletions.
2 changes: 1 addition & 1 deletion 6.4.0/aio/Dockerfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# DO NOT EDIT: created by update_mantainer_version from Dockerfile-debian-aio.template
# DO NOT EDIT: created by update_maintainer_version from Dockerfile-debian-aio.template
FROM debian:bookworm
LABEL maintainer="lachlan-00"

Expand Down
2 changes: 1 addition & 1 deletion 6.4.0/apache/Dockerfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# DO NOT EDIT: created by update_mantainer_version from Dockerfile-debian.template
# DO NOT EDIT: created by update_maintainer_version from Dockerfile-debian.template
FROM debian:bookworm
LABEL maintainer="lachlan-00"

Expand Down
2 changes: 1 addition & 1 deletion 6.5.0/aio/Dockerfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# DO NOT EDIT: created by update_mantainer_version from Dockerfile-debian-aio.template
# DO NOT EDIT: created by update_maintainer_version from Dockerfile-debian-aio.template
FROM debian:bookworm
LABEL maintainer="lachlan-00"

Expand Down
2 changes: 1 addition & 1 deletion 6.5.0/apache/Dockerfile
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# DO NOT EDIT: created by update_mantainer_version from Dockerfile-debian.template
# DO NOT EDIT: created by update_maintainer_version from Dockerfile-debian.template
FROM debian:bookworm
LABEL maintainer="lachlan-00"

Expand Down
39 changes: 13 additions & 26 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,33 +1,23 @@
# ampache-docker
This is a modified version of the origianl repository [Docker image for Ampache](https://github.com/ampache/ampache-docker), a web-based audio/video streaming application and file manager allowing you to access your music & videos from anywhere, using almost any internet-enabled device.
This version was inspired by [Nextcloud Docker](https://github.com/nextcloud/docker) and includes explicit Docker + App variant management, with the addition of a GitHub workflow,

Docker versions generated by this repository have the tag naming convention, `<repo>/<image-name>:<version>[<-variant>]` and provide the creation of explicit image tags:

* `ampache:<version>-aio`: The Ampache All-In-One solution offers easy deployment and maintenance by including all features in a single Docker instance, which is tied to a specific version from the Ampache Releases.
* `ampache:<version>-apache`: The Ampache service that contains a full Ampache installation on an Apache Web Server with Cron . It is designed to use with external MySQL server.

## Modifications and New Features

- **GitHub Workflow**: The addition of a GitHub workflow facilitates Continuous Image Build for each commit or pull request (To do: Add push only on master commit).

- **Explicit Docker varian management**: This refactoring enhances the control and management of Docker variants, shifting the paradigm from variant management via branches (which comes with challenges related to code synchronization, easy comparison, and workflow improvement) to variant management using the more prevalent [GitOneFlow paradigm](https://www.endoflineblog.com/oneflow-a-git-branching-model-and-workflow). This change allows for more efficient and streamlined Docker variant management.
Docker image for Ampache, a web based audio/video streaming application and file manager allowing you to access your music & videos from anywhere, using almost any internet enabled device.

- **Docker tag naming**: This refactoring follow the Docker tags defacto standard naming convention. Specifically, the tags `ampache:<version>-aio` and `ampache:<version>-apache` are used. These tags offer a clear and consistent versioning system, setting a pattern for future versioning, such as for fpm. This approach ensures clarity and consistency in version management.
## NEWS

## Original README Content
This is a modified version of the original repository and was inspired by [Nextcloud Docker](https://github.com/nextcloud/docker) and includes explicit Docker + App variant management, with the addition of a GitHub workflow,

# ampache-docker
Docker versions generated by this repository have the tag naming convention, `<repo>/<image-name>:<version>[<-variant>]` and provide the creation of explicit image tags:

Docker image for Ampache, a web based audio/video streaming application and file manager allowing you to access your music & videos from anywhere, using almost any internet enabled device.
* `ampache:<version>-aio`: The Ampache All-In-One solution offers easy deployment and maintenance by including all features in a single Docker instance, which is tied to a specific version from the Ampache Releases.
* `ampache:<version>-apache`: The Ampache service that contains a full Ampache installation on an Apache Web Server with Cron. It is designed to use with external MySQL server.

## NEWS
### Modifications and New Features

Ampache 5.6.2 had to upgrade from Debian Bullseye to Bookworm.
* **GitHub Workflow**: The addition of a GitHub workflow facilitates Continuous Image Build for each commit or pull request (To do: Add push only on master commit).

MariaDB has been upgraded and has already caused one issue so far.
* **Explicit Docker variant management**: This refactoring enhances the control and management of Docker variants, shifting the paradigm from variant management via branches (which comes with challenges related to code synchronization, easy comparison, and workflow improvement) to Docker variant management using the more prevalent [GitOneFlow paradigm](https://www.endoflineblog.com/oneflow-a-git-branching-model-and-workflow). This change allows for more efficient and streamlined Docker variant management.

Have a look at https://github.com/ampache/ampache-docker/issues/102#issuecomment-1640956439 for information about how it was solved when there was an error during the upgrade.
* **Docker tag naming**: This refactoring follow the Docker tags defacto standard naming convention. Specifically, the tags `ampache:<version>-aio` and `ampache:<version>-apache` are used. These tags offer a clear and consistent versioning system, setting a pattern for future versioning, such as for fpm. This approach ensures clarity and consistency in version management.

## How to use this image

Expand Down Expand Up @@ -101,8 +91,6 @@ Pulls the most recent image from the Master (stable) branch

Pulls the most recent image from the Develop branch. This is generally safe to run but can break occasionally. Contains the latest features and updates.

~~The develop tag is set up to use git updates so you don't have to rebuild your images to stay up to date with development.~~

### `ampache:nosql`

For advanced users, this provides an image without a MySQL server built-in. You must provide your own MySQL server.
Expand Down Expand Up @@ -140,10 +128,9 @@ After installation you will need to setup a catalog. Make sure to use `/media` a

This applies if Ampache is running behind a reverse proxy. The following are typical error messages:

(Ampache\Module\Api\Subsonic_Api) -> Stream error:
(Ampache\Module\Api\Subsonic_Api) -> Stream error: The requested URL returned error: 404 Not Found
`(Ampache\Module\Api\Subsonic_Api) -> Stream error: The requested URL returned error: 404 Not Found`

In ampache.cfg.php set local_web_path to localhost. There are various discussions and issues with more detail on this, see for example: https://github.com/ampache/ampache/issues/1639
In ampache.cfg.php set local_web_path to localhost. There are various discussions and issues with more detail on this, see for example: [ampache/issues/1639](https://github.com/ampache/ampache/issues/1639)

## Themes

Expand All @@ -168,4 +155,4 @@ docker run -d --name=ampache -v ./data/new-theme:/var/www/public/themes/new-them
* @ericfrederich for his original work
* @velocity303 and @goldy for the other ampache-docker inspiration
* @kuzi-moto for bringing the image out of the dark ages

* @Odyno for combining the build process back into one repo
2 changes: 1 addition & 1 deletion update_maintained_versions.sh
Original file line number Diff line number Diff line change
Expand Up @@ -164,7 +164,7 @@ function create_variant() {
mkdir -p "$dir"

template="Dockerfile-${base[$variant]}.template"
echo "# DO NOT EDIT: created by update_mantainer_version from $template " > "$dir/Dockerfile"
echo "# DO NOT EDIT: created by update_maintainer_version from $template " > "$dir/Dockerfile"
cat "$template" >> "$dir/Dockerfile"

# Replace the variables.
Expand Down

0 comments on commit f151cba

Please sign in to comment.