kopia lustrzana https://github.com/linuxserver/docker-documentation
Bot Updating Documentation
LinuxServer-CI
rodzic
30adfc6f4f
commit
6ef344380b
|
|
@ -22,6 +22,7 @@ The [LinuxServer.io](https://linuxserver.io) team brings you another container r
|
|||
* regular security updates
|
||||
|
||||
Find us at:
|
||||
|
||||
* [Blog](https://blog.linuxserver.io) - all the things you can do with our containers including How-To guides, opinions and much more!
|
||||
* [Discord](https://discord.gg/YWrKVTn) - realtime support / chat with the community and the team.
|
||||
* [Discourse](https://discourse.linuxserver.io) - post on our community forum.
|
||||
|
|
@ -31,39 +32,43 @@ Find us at:
|
|||
|
||||
# [linuxserver/docker-compose](https://github.com/linuxserver/docker-docker-compose)
|
||||
|
||||
[](https://scarf.sh/gateway/linuxserver-ci/docker/linuxserver%2Fdocker-compose)
|
||||
[](https://github.com/linuxserver/docker-docker-compose)
|
||||
[](https://github.com/linuxserver/docker-docker-compose/releases)
|
||||
[](https://github.com/linuxserver/docker-docker-compose/releases)
|
||||
[](https://github.com/linuxserver/docker-docker-compose/packages)
|
||||
[](https://gitlab.com/Linuxserver.io/docker-docker-compose/container_registry)
|
||||
[](https://microbadger.com/images/linuxserver/docker-compose "Get your own version badge on microbadger.com")
|
||||
[](https://gitlab.com/linuxserver.io/docker-docker-compose/container_registry)
|
||||
[](https://quay.io/repository/linuxserver.io/docker-compose)
|
||||
[](https://hub.docker.com/r/linuxserver/docker-compose)
|
||||
[](https://hub.docker.com/r/linuxserver/docker-compose)
|
||||
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-docker-compose/job/master/)
|
||||
|
||||
[Docker-compose](https://github.com/docker/compose) is a tool for defining and running multi-container Docker applications. With Compose, you use a Compose file to configure your application's services. Then, using a single command, you create and start all the services from your configuration.
|
||||
[docker-compose](https://github.com/docker-compose/docker-compose) is a tool for defining and running multi-container Docker applications. With Compose, you use a Compose file to configure your application's services. Then, using a single command, you create and start all the services from your configuration.
|
||||
|
||||
[](https://github.com/docker/compose)
|
||||
[](https://github.com/docker-compose/docker-compose)
|
||||
|
||||
## Supported Architectures
|
||||
|
||||
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) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
|
||||
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) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
|
||||
|
||||
Simply pulling `linuxserver/docker-compose` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
|
||||
Simply pulling `lscr.io/linuxserver/docker-compose:latest` 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:
|
||||
|
||||
| Architecture | Tag |
|
||||
| :----: | --- |
|
||||
| x86-64 | amd64-latest |
|
||||
| arm64 | arm64v8-latest |
|
||||
| armhf | arm32v7-latest |
|
||||
| Architecture | Available | Tag |
|
||||
| :----: | :----: | ---- |
|
||||
| x86-64 | ✅ | amd64-\<version tag\> |
|
||||
| arm64 | ✅ | arm64v8-\<version tag\> |
|
||||
| armhf| ✅ | arm32v7-\<version tag\> |
|
||||
|
||||
## Version Tags
|
||||
This image provides various versions that are available via tags.
|
||||
| Tag | Description |
|
||||
| :----: | --- |
|
||||
| latest | Ubuntu based images |
|
||||
| alpine | Alpine based images |
|
||||
|
||||
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
|
||||
|
||||
| Tag | Available | Description |
|
||||
| :----: | :----: |--- |
|
||||
| latest | ✅ | docker-compose v1 releases |
|
||||
| alpine | ✅ | docker-compose v1 releases with our alpine baseimage |
|
||||
| v2 | ✅ | docker compose v2 releases |
|
||||
|
||||
## Usage
|
||||
|
||||
|
|
@ -74,7 +79,7 @@ docker run --rm \
|
|||
-v /var/run/docker.sock:/var/run/docker.sock \
|
||||
-v "$PWD:$PWD" \
|
||||
-w="$PWD" \
|
||||
linuxserver/docker-compose \
|
||||
lscr.io/linuxserver/docker-compose:latest \
|
||||
up
|
||||
```
|
||||
You can replace the last line with any docker-compose command and argument, which will be passed to docker-compose inside the image.
|
||||
|
|
@ -90,42 +95,48 @@ sudo chmod +x /usr/local/bin/docker-compose
|
|||
|
||||
Running these two commands on your docker host once will let you issue commands such as `docker-compose up -d` and the docker-compose container will do its job behind the scenes.
|
||||
|
||||
### Binaries
|
||||
|
||||
We are also providing the binaries for both docker-compose and docker-cli for all three arches in Github releases. You can download the correct binaries for your arch directly and drop into `/usr/local/bin/`.
|
||||
|
||||
## Docker Mods
|
||||
[](https://mods.linuxserver.io/?mod=docker-compose "view available mods for this container.")
|
||||
|
||||
We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image (if any) can be accessed via the dynamic badge above.
|
||||
[](https://mods.linuxserver.io/?mod=docker-compose "view available mods for this container.") [](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
|
||||
|
||||
We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.
|
||||
|
||||
## Support Info
|
||||
|
||||
* Shell access whilst the container is running: `docker exec -it docker-compose /bin/bash`
|
||||
* To monitor the logs of the container in realtime: `docker logs -f docker-compose`
|
||||
* container version number
|
||||
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' docker-compose`
|
||||
* image version number
|
||||
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/docker-compose`
|
||||
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/docker-compose:latest`
|
||||
|
||||
## Updating Info
|
||||
|
||||
### Via Docker Cli
|
||||
* Update the image: `docker pull linuxserver/docker-compose`
|
||||
* You can also remove the old dangling images: `docker image prune`
|
||||
Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (ie. nextcloud, plex), we do not recommend or support updating apps inside the container. Please consult the [Application Setup](#application-setup) section above to see if it is recommended for the image.
|
||||
|
||||
Below are the instructions for updating containers:
|
||||
|
||||
### Via Docker Run
|
||||
|
||||
* Update the image: `docker pull lscr.io/linuxserver/docker-compose:latest`
|
||||
* You can also remove the old dangling images: `docker image prune`
|
||||
|
||||
## Building locally
|
||||
|
||||
If you want to make local modifications to these images for development purposes or just to customize the logic:
|
||||
```
|
||||
|
||||
```bash
|
||||
git clone https://github.com/linuxserver/docker-docker-compose.git
|
||||
cd docker-docker-compose
|
||||
docker build \
|
||||
--no-cache \
|
||||
--pull \
|
||||
-t linuxserver/docker-compose:latest .
|
||||
-t lscr.io/linuxserver/docker-compose:latest .
|
||||
```
|
||||
|
||||
The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static`
|
||||
```
|
||||
|
||||
```bash
|
||||
docker run --rm --privileged multiarch/qemu-user-static:register --reset
|
||||
```
|
||||
|
||||
|
|
@ -133,6 +144,7 @@ Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64
|
|||
|
||||
## Versions
|
||||
|
||||
* **15.03.22:** - Add v2 branch. Change master to only fetch v1 releases. Change alpine to only fetch v1 releases. Rebase master to focal. Rebase alpine to 3.15.
|
||||
* **17.12.20:** - Update run.sh with formatting changes.
|
||||
* **04.10.20:** - Update run.sh with changes from upstream.
|
||||
* **31.08.20:** - Update tox and virtualenv.
|
||||
|
|
|
|||
Ładowanie…
Reference in New Issue