kopia lustrzana https://github.com/linuxserver/docker-documentation
Bot Updating Templated Files
LinuxServer-CI
rodzic
e7b6ffd654
commit
c2d6b3b6ab
|
|
@ -1,103 +1,132 @@
|
|||
[linuxserverurl]: https://linuxserver.io
|
||||
[forumurl]: https://forum.linuxserver.io
|
||||
[ircurl]: https://www.linuxserver.io/irc/
|
||||
[podcasturl]: https://www.linuxserver.io/podcast/
|
||||
[appurl]: https://github.com/airsonic/airsonic
|
||||
[hub]: https://hub.docker.com/r/linuxserver/airsonic/
|
||||
# [linuxserver/airsonic](https://github.com/linuxserver/docker-airsonic)
|
||||
|
||||
[](https://discord.gg/YWrKVTn)
|
||||
[](https://microbadger.com/images/linuxserver/airsonic "Get your own version badge on microbadger.com")
|
||||
[](https://microbadger.com/images/linuxserver/airsonic "Get your own version badge on microbadger.com")
|
||||
|
||||
|
||||
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-airsonic/job/master/)
|
||||
[](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/airsonic/latest/index.html)
|
||||
|
||||
[][linuxserverurl]
|
||||
[Airsonic](https://github.com/airsonic/airsonic) is a free, web-based media streamer, providing ubiquitious access to your music. Use it to share your music with friends, or to listen to your own music while at work. You can stream to multiple players simultaneously, for instance to one player in your kitchen and another in your living room.
|
||||
|
||||
## Supported Architectures
|
||||
|
||||
## Contact information:-
|
||||
Our images support multiple architectures such as `x86-64`, `arm64` and `armhf`. We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list).
|
||||
|
||||
| Type | Address/Details |
|
||||
| :---: | --- |
|
||||
| Discord | [Discord](https://discord.gg/YWrKVTn) |
|
||||
| Forum | [Linuserver.io forum][forumurl] |
|
||||
| IRC | freenode at `#linuxserver.io` more information at:- [IRC][ircurl]
|
||||
| Podcast | Covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation! [Linuxserver.io Podcast][podcasturl] |
|
||||
Simply pulling `linuxserver/airsonic` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
|
||||
|
||||
The architectures supported by this image are:
|
||||
|
||||
The [LinuxServer.io][linuxserverurl] team brings you another image release featuring :-
|
||||
| Architecture | Tag |
|
||||
| :----: | --- |
|
||||
| x86-64 | amd64-latest |
|
||||
| arm64 | arm64v8-latest |
|
||||
| armhf | arm32v6-latest |
|
||||
|
||||
+ regular and timely application updates
|
||||
+ easy user mappings
|
||||
+ custom base image with s6 overlay
|
||||
+ weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
|
||||
+ security updates
|
||||
|
||||
# linuxserver/airsonic
|
||||
[](https://microbadger.com/images/linuxserver/airsonic "Get your own version badge on microbadger.com")[](https://microbadger.com/images/linuxserver/airsonic "Get your own image badge on microbadger.com")[][hub][][hub][](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-airsonic/)
|
||||
|
||||
Airsonic is a free, web-based media streamer, providing ubiquitious access to your music. Use it to share your music with friends, or to listen to your own music while at work. You can stream to multiple players simultaneously, for instance to one player in your kitchen and another in your living room.
|
||||
|
||||
[][appurl]
|
||||
|
||||
|
||||
|
||||
## Usage
|
||||
|
||||
Here are some example snippets to help you get started creating a container from this image.
|
||||
|
||||
### docker
|
||||
|
||||
```
|
||||
docker create \
|
||||
--name=airsonic \
|
||||
-v </path/to/config>:/config \
|
||||
-v </path/to/music>:/music \
|
||||
-v </path/to/playlists>:/playlists \
|
||||
-v </path/to/podcasts>:/podcasts \
|
||||
-v </path/to/other media>:/media \
|
||||
-e PGID=<gid> -e PUID=<uid> \
|
||||
-e CONTEXT_PATH=<url-base> \
|
||||
-e JAVA_OPTS=<options> \
|
||||
-e TZ=<timezone> \
|
||||
-p 4040:4040 \
|
||||
linuxserver/airsonic
|
||||
|
||||
--name=airsonic \
|
||||
-e PUID=1001 \
|
||||
-e PGID=1001 \
|
||||
-e TZ=Europe/London \
|
||||
-e CONTEXT_PATH=<URL_BASE> `#optional` \
|
||||
-e JAVA_OPTS=<options> `#optional` \
|
||||
-p 4040:4040 \
|
||||
-v </path/to/config>:/config \
|
||||
-v </path/to/music>:/music \
|
||||
-v </path/to/playlists>:/playlists \
|
||||
-v </path/to/podcasts>:/podcasts \
|
||||
-v </path/to/other media>:/media `#optional` \
|
||||
--restart unless-stopped \
|
||||
linuxserver/airsonic
|
||||
```
|
||||
|
||||
|
||||
|
||||
### docker-compose
|
||||
|
||||
Compatible with docker-compose v2 schemas.
|
||||
|
||||
```yaml
|
||||
---
|
||||
version: "2"
|
||||
services:
|
||||
airsonic:
|
||||
image: linuxserver/airsonic
|
||||
container_name: airsonic
|
||||
environment:
|
||||
- PUID=1001
|
||||
- PGID=1001
|
||||
- TZ=Europe/London
|
||||
- CONTEXT_PATH=<URL_BASE> #optional
|
||||
- JAVA_OPTS=<options> #optional
|
||||
volumes:
|
||||
- </path/to/config>:/config
|
||||
- </path/to/music>:/music
|
||||
- </path/to/playlists>:/playlists
|
||||
- </path/to/podcasts>:/podcasts
|
||||
volumes:
|
||||
- </path/to/other media>:/media #optional
|
||||
ports:
|
||||
- 4040:4040
|
||||
mem_limit: 4096m
|
||||
restart: unless-stopped
|
||||
```
|
||||
|
||||
## Parameters
|
||||
|
||||
The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side.
|
||||
For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container.
|
||||
So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080
|
||||
http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.
|
||||
|
||||
Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `<external>:<internal>` respectively. For example, `-p 8080:80` would expose port `80` from inside the container to be accessible from the host's IP on port `8080` outside the container.
|
||||
|
||||
### Ports (`-p`)
|
||||
|
||||
| Parameter | Function |
|
||||
| :---: | --- |
|
||||
| `-p 4040` | the port(s) |
|
||||
| `-v /config` | Configuration file location |
|
||||
| `-v /music` | Location of music. |
|
||||
| `-v /playlists` | Location for playlists to be saved to. |
|
||||
| `-v /podcasts` | Location of podcasts. |
|
||||
| `-v /media` | Location of other media - *optional* |
|
||||
| `-e PUID` | for UserID, see below for explanation |
|
||||
| `-e GUID` | for GroupID, see below for explanation |
|
||||
| `-e CONTEXT_PATH` | for setting url-base in reverse proxy setups - *optional* |
|
||||
| `-e JAVA_OPTS` | for passing additional java options - *optional* |
|
||||
| `-e TZ` | for setting timezone information, eg Europe/London |
|
||||
| :----: | --- |
|
||||
| `4040` | WebUI |
|
||||
|
||||
|
||||
### Environment Variables (`-e`)
|
||||
|
||||
| Env | Function |
|
||||
| :----: | --- |
|
||||
| `PUID=1001` | for UserID - see below for explanation |
|
||||
| `PGID=1001` | for GroupID - see below for explanation |
|
||||
| `TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
|
||||
| `CONTEXT_PATH=<URL_BASE>` | For setting url-base in reverse proxy setups. |
|
||||
| `JAVA_OPTS=<options>` | For passing additional java options. |
|
||||
|
||||
### Volume Mappings (`-v`)
|
||||
|
||||
| Volume | Function |
|
||||
| :----: | --- |
|
||||
| `/config` | Configuration file location. |
|
||||
| `/music` | Location of music. |
|
||||
| `/playlists` | Location for playlists to be saved to. |
|
||||
| `/podcasts` | Location of podcasts. |
|
||||
| `/media` | Location of other media. |
|
||||
|
||||
|
||||
|
||||
|
||||
## User / Group Identifiers
|
||||
|
||||
Sometimes when using volumes (`-v` flags) permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`.
|
||||
When using volumes (`-v` flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user `PUID` and group `PGID`.
|
||||
|
||||
Ensure any volume directories on the host are owned by the same user you specify and it will "just work" ™.
|
||||
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
|
||||
|
||||
In this instance `PUID=1001` and `PGID=1001`, to find yours use `id user` as below:
|
||||
|
||||
```
|
||||
$ id <dockeruser>
|
||||
$ id username
|
||||
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
|
||||
```
|
||||
|
||||
|
||||
|
||||
## Setting up the application
|
||||
## Application Setup
|
||||
|
||||
Access WebUI at `<your-ip>:4040`.
|
||||
|
||||
|
|
@ -105,26 +134,24 @@ Default user/pass is admin/admin
|
|||
|
||||
Extra java options can be passed with the JAVA_OPTS environment variable, eg `-e JAVA_OPTS="-Xmx256m -Xms256m"`
|
||||
|
||||
|
||||
|
||||
## Container access and information.
|
||||
|
||||
| Function | Command |
|
||||
| :--- | :--- |
|
||||
| Shell access (live container) | `docker exec -it airsonic /bin/bash` |
|
||||
| Realtime container logs | `docker logs -f airsonic` |
|
||||
| Container version number | `docker inspect -f '{{ index .Config.Labels "build_version" }}' airsonic` |
|
||||
| Image version number | `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/airsonic` |
|
||||
## Support Info
|
||||
|
||||
|
||||
* Shell access whilst the container is running:
|
||||
* `docker exec -it airsonic /bin/bash`
|
||||
* To monitor the logs of the container in realtime:
|
||||
* `docker logs -f airsonic`
|
||||
* Container version number
|
||||
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' airsonic`
|
||||
* Image version number
|
||||
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/airsonic`
|
||||
|
||||
## Versions
|
||||
|
||||
| Date | Changes |
|
||||
| :---: | --- |
|
||||
| 26.01.19 | Adding pipeline logic and multi arch. |
|
||||
| 05.01.19 | Linting fixes. |
|
||||
| 27.08.18 | Use new inhouse java baseimage for quicker builds. |
|
||||
| 23.08.18 | Rebase to ubuntu bionic for increased performance across all arch's. |
|
||||
| 22.04.18 | Add the forgotten JAVA_OPTS to the run command. |
|
||||
| 29.12.17 | Initial Release. |
|
||||
* **26.01.19:** - Add pipeline logic and multi arch.
|
||||
* **05.01.19:** - Linting fixes.
|
||||
* **27.08.18:** - Use new inhouse java baseimage for quicker builds.
|
||||
* **23.08.18:** - Rebase to ubuntu bionic for increased performance across all arch's.
|
||||
* **22.04.18:** - Add the forgotten JAVA_OPTS to the run command.
|
||||
* **29.12.17:** - Initial Release.
|
||||
|
|
|
|||
Ładowanie…
Reference in New Issue