mirror of
https://github.com/linuxserver/docker-ombi.git
synced 2026-02-20 00:58:02 +08:00
update readme and fenkinsfile
This commit is contained in:
aptalca
parent
6dfe0398dd
commit
b35d78d78a
9
Jenkinsfile
vendored
9
Jenkinsfile
vendored
@ -200,6 +200,15 @@ pipeline {
|
||||
else
|
||||
echo "false" > /tmp/${COMMIT_SHA}-${BUILD_NUMBER}
|
||||
fi
|
||||
mkdir -p ${TEMPDIR}/gitbook
|
||||
git clone https://github.com/linuxserver/docker-documentation.git ${TEMPDIR}/gitbook/docker-documentation
|
||||
if [ "${BRANCH_NAME}" = "master" ] && [ ! -f ${TEMPDIR}/gitbook/docker-documentation/images/docker-${CONTAINER_NAME}.md ] || [ "$(md5sum ${TEMPDIR}/gitbook/docker-documentation/images/docker-${CONTAINER_NAME}.md | awk '{ print $1 }')" != "$(md5sum ${TEMPDIR}/${CONTAINER_NAME}/docker-${CONTAINER_NAME}.md | awk '{ print $1 }')" ]; then
|
||||
cp ${TEMPDIR}/${CONTAINER_NAME}/docker-${CONTAINER_NAME}.md ${TEMPDIR}/gitbook/docker-documentation/images/
|
||||
cd ${TEMPDIR}/gitbook/docker-documentation/
|
||||
git add images/docker-${CONTAINER_NAME}.md
|
||||
git commit -m 'Bot Updating Templated Files'
|
||||
git push https://LinuxServer-CI:${GITHUB_TOKEN}@github.com/linuxserver/docker-documentation.git --all
|
||||
fi
|
||||
rm -Rf ${TEMPDIR}'''
|
||||
script{
|
||||
env.FILES_UPDATED = sh(
|
||||
|
||||
46
README.md
46
README.md
@ -26,12 +26,11 @@ TLDR: Multi-arch support is changing from multiple repos to one repo per contain
|
||||
[](https://microbadger.com/images/linuxserver/ombi "Get your own version badge on microbadger.com")
|
||||
|
||||
|
||||
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-ombi/job/master/)
|
||||
[](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/ombi/latest/index.html)
|
||||
|
||||
[Ombi](https://ombi.io) allows you to host your own Plex Request and user management system.
|
||||
If you are sharing your Plex server with other users, allow them to request new content using an easy to manage interface!
|
||||
Manage all your requests for Movies and TV with ease, leave notes for the user and get notification when a user requests something.
|
||||
Allow your users to post issues against their requests so you know there is a problem with the audio etc.
|
||||
Even automatically sent them weekly newsletters of new content that has been added to your Plex server!
|
||||
If you are sharing your Plex server with other users, allow them to request new content using an easy to manage interface! Manage all your requests for Movies and TV with ease, leave notes for the user and get notification when a user requests something. Allow your users to post issues against their requests so you know there is a problem with the audio etc. Even automatically send them weekly newsletters of new content that has been added to your Plex server!
|
||||
|
||||
[](https://ombi.io)
|
||||
|
||||
@ -39,6 +38,8 @@ Even automatically sent them weekly newsletters of new content that has been add
|
||||
|
||||
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).
|
||||
|
||||
Simply pulling `linuxserver/ombi` 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 |
|
||||
@ -47,6 +48,15 @@ The architectures supported by this image are:
|
||||
| arm64 | arm64v8-latest |
|
||||
| armhf | arm32v6-latest |
|
||||
|
||||
## Version Tags
|
||||
|
||||
This image provides various versions that are available via tags. `latest` tag usually provides the latest stable version. Others are considered under development and caution must be exercised when using them.
|
||||
|
||||
| Tag | Description |
|
||||
| :----: | --- |
|
||||
| latest | Stable Ombi releases |
|
||||
| development | Releases from the `develop` branch of Ombi |
|
||||
|
||||
## Usage
|
||||
|
||||
Here are some example snippets to help you get started creating a container.
|
||||
@ -65,11 +75,6 @@ docker create \
|
||||
linuxserver/ombi
|
||||
```
|
||||
|
||||
Using tags, you can choose between various versions of ombi. No tag is required to remain on the latest stable release.
|
||||
Add one of the tags, if required, to the `linuxserver/ombi` line of the run/create command in the following format, `linuxserver/ombi:development`
|
||||
The development tag will be the latest commit in the `develop` branch of ombi.
|
||||
HOWEVER, USE THE DEVELOPMENT BRANCH AT YOUR OWN PERIL !!!!!!!!!
|
||||
|
||||
|
||||
### docker-compose
|
||||
|
||||
@ -119,6 +124,7 @@ In this instance `PUID=1001` and `PGID=1001`, to find yours use `id user` as bel
|
||||
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
|
||||
```
|
||||
|
||||
|
||||
|
||||
## Application Setup
|
||||
|
||||
@ -135,10 +141,30 @@ Access the webui at `<your-ip>:3579`. Follow the setup wizard on initial install
|
||||
* image version number
|
||||
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/ombi`
|
||||
|
||||
## Updating Info
|
||||
|
||||
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/Create
|
||||
* Update the image: `docker pull linuxserver/ombi`
|
||||
* Stop the running container: `docker stop ombi`
|
||||
* Delete the container: `docker rm ombi`
|
||||
* Recreate a new container with the same docker create parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved)
|
||||
* Start the new container: `docker start ombi`
|
||||
* You can also remove the old dangling images: `docker image prune`
|
||||
|
||||
### Via Docker Compose
|
||||
* Update the image: `docker-compose pull linuxserver/ombi`
|
||||
* Let compose update containers as necessary: `docker-compose up -d`
|
||||
* You can also remove the old dangling images: `docker image prune`
|
||||
|
||||
## Versions
|
||||
|
||||
* **22.02.19:** - Clarify info on tags and development builds.
|
||||
* **25.01.19:** - Add info on tags and development builds.
|
||||
* **17.12.18:** - Switch to multi-arch builds and add aarch64 image.
|
||||
* **09.01.19:** - Switch to multi-arch builds and add aarch64 image.
|
||||
* **11.03.18:** - Add HOME env to Dockerfile.
|
||||
* **05.03.18:** - Switch to Ombi v3 stable based on .net core.
|
||||
* **26.01.18:** - Fix continuation lines.
|
||||
|
||||
@ -7,12 +7,9 @@ project_logo: "https://raw.githubusercontent.com/linuxserver/docker-templates/ma
|
||||
project_blurb: "[{{ project_name|capitalize }}]({{ project_url }}) allows you to host your own Plex Request and user management system.
|
||||
|
||||
If you are sharing your Plex server with other users, allow them to request new content using an easy to manage interface!
|
||||
|
||||
Manage all your requests for Movies and TV with ease, leave notes for the user and get notification when a user requests something.
|
||||
|
||||
Allow your users to post issues against their requests so you know there is a problem with the audio etc.
|
||||
|
||||
Even automatically sent them weekly newsletters of new content that has been added to your Plex server!"
|
||||
Even automatically send them weekly newsletters of new content that has been added to your Plex server!"
|
||||
project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}"
|
||||
|
||||
# supported architectures
|
||||
@ -21,6 +18,12 @@ available_architectures:
|
||||
- { arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"}
|
||||
- { arch: "{{ arch_armhf }}", tag: "arm32v6-latest"}
|
||||
|
||||
# development version
|
||||
development_versions: true
|
||||
development_versions_items:
|
||||
- { tag: "latest", desc: "Stable Ombi releases" }
|
||||
- { tag: "development", desc: "Releases from the `develop` branch of Ombi" }
|
||||
|
||||
# container parameters
|
||||
common_param_env_vars_enabled: true
|
||||
param_container_name: "{{ project_name }}"
|
||||
@ -35,23 +38,18 @@ param_env_vars:
|
||||
- { env_var: "TZ", env_value: "Europe/London", desc: "Specify a timezone to use EG Europe/London"}
|
||||
|
||||
# optional parameters
|
||||
optional_block_1: true
|
||||
optional_block_1_items:
|
||||
- |
|
||||
Using tags, you can choose between various versions of ombi. No tag is required to remain on the latest stable release.
|
||||
Add one of the tags, if required, to the `linuxserver/ombi` line of the run/create command in the following format, `linuxserver/ombi:development`
|
||||
The development tag will be the latest commit in the `develop` branch of ombi.
|
||||
HOWEVER, USE THE DEVELOPMENT BRANCH AT YOUR OWN PERIL !!!!!!!!!
|
||||
optional_block_1: false
|
||||
optional_block_1_items: ""
|
||||
|
||||
# application setup block
|
||||
app_setup_block_enabled: true
|
||||
app_setup_block: |
|
||||
Access the webui at `<your-ip>:3579`. Follow the setup wizard on initial install. Then configure the required services.
|
||||
|
||||
# changelog
|
||||
changelogs:
|
||||
- { date: "22.02.19:", desc: "Clarify info on tags and development builds." }
|
||||
- { date: "25.01.19:", desc: "Add info on tags and development builds." }
|
||||
- { date: "17.12.18:", desc: "Switch to multi-arch builds and add aarch64 image." }
|
||||
- { date: "09.01.19:", desc: "Switch to multi-arch builds and add aarch64 image." }
|
||||
- { date: "11.03.18:", desc: "Add HOME env to Dockerfile." }
|
||||
- { date: "05.03.18:", desc: "Switch to Ombi v3 stable based on .net core." }
|
||||
- { date: "26.01.18:", desc: "Fix continuation lines." }
|
||||
|
||||
Loading…
x
Reference in New Issue
Block a user