Skip to content

Commit 0d050dc

Browse files
j0nnymoej0nnymoe
authored
Merge pull request #14 from linuxserver/pipeline-readme
Pipeline readme
2 parents 46d8cc5 + 0364722 commit 0d050dc

File tree

2 files changed

+144
-136
lines changed

2 files changed

+144
-136
lines changed

‎README.md‎

Lines changed: 103 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,85 +1,140 @@
1-
[linuxserverurl]: https://linuxserver.io
2-
[forumurl]: https://forum.linuxserver.io
3-
[ircurl]: https://www.linuxserver.io/irc/
4-
[podcasturl]: https://www.linuxserver.io/podcast/
5-
[appurl]: https://www.duplicati.com
6-
[hub]: https://hub.docker.com/r/linuxserver/duplicati/
1+
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)](https://linuxserver.io)
72

8-
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl]
3+
The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring :-
94

10-
The [LinuxServer.io][linuxserverurl] team brings you another container release featuring easy user mapping and community support. Find us for support at:
11-
* [forum.linuxserver.io][forumurl]
12-
* [IRC][ircurl] on freenode at `#linuxserver.io`
13-
* [Podcast][podcasturl] covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation!
5+
* regular and timely application updates
6+
* easy user mappings (PGID, PUID)
7+
* custom base image with s6 overlay
8+
* weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
9+
* regular security updates
1410

15-
# linuxserver/duplicati
16-
[![](https://images.microbadger.com/badges/version/linuxserver/duplicati.svg)](https://microbadger.com/images/linuxserver/duplicati "Get your own version badge on microbadger.com")[![](https://images.microbadger.com/badges/image/linuxserver/duplicati.svg)](https://microbadger.com/images/linuxserver/duplicati "Get your own image badge on microbadger.com")[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/duplicati.svg)][hub][![Docker Stars](https://img.shields.io/docker/stars/linuxserver/duplicati.svg)][hub][![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Builders/x86-64/x86-64-duplicati)](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-duplicati/)
11+
Find us at:
12+
* [Discord](https://discord.gg/YWrKVTn) - realtime support / chat with the community and the team.
13+
* [IRC](https://irc.linuxserver.io) - on freenode at `#linuxserver.io`. Our primary support channel is Discord.
14+
* [Blog](https://blog.linuxserver.io) - all the things you can do with our containers including How-To guides, opinions and much more!
15+
* [Podcast](https://anchor.fm/linuxserverio) - on hiatus. Coming back soon (late 2018).
1716

18-
[Duplicati][appurl] works with standard protocols like FTP, SSH, WebDAV as well as popular services like Microsoft OneDrive, Amazon Cloud Drive & S3, Google Drive, box.com, Mega, hubiC and many others.
17+
# PSA: Changes are happening
1918

20-
[![duplicati](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/duplicati-icon.png)][appurl]
19+
From August 2018 onwards, Linuxserver are in the midst of switching to a new CI platform which will enable us to build and release multiple architectures under a single repo. To this end, existing images for `arm64` and `armhf` builds are being deprecated. They are replaced by a manifest file in each container which automatically pulls the correct image for your architecture. You'll also be able to pull based on a specific architecture tag.
20+
21+
TLDR: Multi-arch support is changing from multiple repos to one repo per container image.
22+
23+
# [linuxserver/duplicati](https://github.com/linuxserver/docker-duplicati)
24+
[![](https://img.shields.io/discord/354974912613449730.svg?logo=discord&label=LSIO%20Discord&style=flat-square)](https://discord.gg/YWrKVTn)
25+
[![](https://images.microbadger.com/badges/version/linuxserver/duplicati.svg)](https://microbadger.com/images/linuxserver/duplicati "Get your own version badge on microbadger.com")
26+
[![](https://images.microbadger.com/badges/image/linuxserver/duplicati.svg)](https://microbadger.com/images/linuxserver/duplicati "Get your own version badge on microbadger.com")
27+
![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/duplicati.svg)
28+
![Docker Stars](https://img.shields.io/docker/stars/linuxserver/duplicati.svg)
29+
30+
[Duplicati](https://www.duplicati.com/) works with standard protocols like FTP, SSH, WebDAV as well as popular services like Microsoft OneDrive, Amazon Cloud Drive & S3, Google Drive, box.com, Mega, hubiC and many others.
31+
32+
[![duplicati](https://github.com/linuxserver/docker-templates/raw/master/linuxserver.io/img/duplicati-icon.png)](https://www.duplicati.com/)
33+
34+
## Supported Architectures
35+
36+
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).
37+
38+
The architectures supported by this image are:
39+
40+
| Architecture | Tag |
41+
| :----: | --- |
42+
| x86-64 | amd64-latest |
43+
| arm64 | arm64v8-latest |
44+
| armhf | arm32v6-latest |
2145

2246
## Usage
2347

48+
Here are some example snippets to help you get started creating a container.
49+
50+
### docker
51+
2452
```
2553
docker create \
2654
--name=duplicati \
27-
-v <path to data>:/config \
28-
-v <path to data>:/backups \
29-
-v <path to data>:/source \
30-
-e PGID=<gid> -e PUID=<uid> \
55+
-e PUID=1001 \
56+
-e PGID=1001 \
57+
-e TZ=Europe/London \
3158
-p 8200:8200 \
59+
-v </path/to/appdata/config>:/config \
60+
-v </path/to/backups>:/backups \
61+
-v </path/to/source>:/source \
62+
--restart unless-stopped \
3263
linuxserver/duplicati
3364
```
3465

35-
## Parameters
3666

37-
`The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side.
38-
For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container.
39-
So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080
40-
http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.`
67+
### docker-compose
4168

69+
Compatible with docker-compose v2 schemas.
4270

71+
```
72+
---
73+
version: "2"
74+
services:
75+
duplicati:
76+
image: linuxserver/duplicati
77+
container_name: duplicati
78+
environment:
79+
- PUID=1001
80+
- PGID=1001
81+
- TZ=Europe/London
82+
volumes:
83+
- </path/to/appdata/config>:/config
84+
- </path/to/backups>:/backups
85+
- </path/to/source>:/source
86+
ports:
87+
- 8200:8200
88+
mem_limit: 4096m
89+
restart: unless-stopped
90+
```
91+
92+
## Parameters
93+
94+
Container 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.
4395

44-
* `-p 8200` - the port(s)
45-
* `-v /config` - path for duplicati config files
46-
* `-v /backups` - path to store local backups
47-
* `-v /source` - path to source for files to backup
48-
* `-e PGID` for GroupID - see below for explanation
49-
* `-e PUID` for UserID - see below for explanation
96+
| Parameter | Function |
97+
| :----: | --- |
98+
| `-p 8200` | http gui |
99+
| `-e PUID=1001` | for UserID - see below for explanation |
100+
| `-e PGID=1001` | for GroupID - see below for explanation |
101+
| `-e TZ=Europe/London` | Specify a timezone to use EG Europe/London |
102+
| `-v /config` | Contains all relevant configuration files. |
103+
| `-v /backups` | Path to store local backups. |
104+
| `-v /source` | Path to source for files to backup. |
50105

51-
It is based on ubuntu xenial with s6 overlay, for shell access whilst the container is running do `docker exec -it duplicati /bin/bash`.
106+
## User / Group Identifiers
52107

53-
### User / Group Identifiers
108+
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`.
54109

55-
Sometimes when using data 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 the data volume directory on the host is owned by the same user you specify and it will "just work" ™.
110+
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
56111

57-
In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as below:
112+
In this instance `PUID=1001` and `PGID=1001`, to find yours use `id user` as below:
58113

59114
```
60-
$ id <dockeruser>
115+
$ id username
61116
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
62117
```
63118

64-
## Setting up the application
119+
&nbsp;
120+
## Application Setup
65121

66-
The webui is at `<your ip>:8200` , create backup jobs etc via the webui, for local backups select `/backups` as the destination. For more information see [Duplicati][appurl].
122+
The webui is at `<your ip>:8200` , create backup jobs etc via the webui, for local backups select `/backups` as the destination. For more information see [Duplicati](https://www.duplicati.com/).
67123

68-
## Info
69124

70-
* Shell access whilst the container is running: `docker exec -it duplicati /bin/bash`
71-
* To monitor the logs of the container in realtime: `docker logs -f duplicati`
72-
73-
* container version number
74125

75-
`docker inspect -f '{{ index .Config.Labels "build_version" }}' duplicati`
126+
## Support Info
76127

128+
* Shell access whilst the container is running: `docker exec -it duplicati /bin/bash`
129+
* To monitor the logs of the container in realtime: `docker logs -f duplicati`
130+
* container version number
131+
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' duplicati`
77132
* image version number
78-
79-
`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/duplicati`
133+
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/duplicati`
80134

81135
## Versions
82136

83-
+ **09.12.17:** Fix continuation lines.
84-
+ **31.08.17:** Build only beta or release versions (thanks deasmi).
85-
+ **24.04.17:** Initial Release.
137+
* **11.01.19:** - Multi-arch image.
138+
* **09.12.17:** - Fix continuation lines.
139+
* **31.08.17:** - Build only beta or release versions (thanks deasmi).
140+
* **24.04.17:** - Initial release.

‎readme-vars.yml‎

Lines changed: 41 additions & 88 deletions
Original file line numberDiff line numberDiff line change
@@ -2,91 +2,44 @@
22

33
# project information
44
project_name: duplicati
5-
full_custom_readme: |
6-
{% raw -%}
7-
[linuxserverurl]: https://linuxserver.io
8-
[forumurl]: https://forum.linuxserver.io
9-
[ircurl]: https://www.linuxserver.io/irc/
10-
[podcasturl]: https://www.linuxserver.io/podcast/
11-
[appurl]: https://www.duplicati.com
12-
[hub]: https://hub.docker.com/r/linuxserver/duplicati/
13-
14-
[![linuxserver.io](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/linuxserver_medium.png)][linuxserverurl]
15-
16-
The [LinuxServer.io][linuxserverurl] team brings you another container release featuring easy user mapping and community support. Find us for support at:
17-
* [forum.linuxserver.io][forumurl]
18-
* [IRC][ircurl] on freenode at `#linuxserver.io`
19-
* [Podcast][podcasturl] covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation!
20-
21-
# linuxserver/duplicati
22-
[![](https://images.microbadger.com/badges/version/linuxserver/duplicati.svg)](https://microbadger.com/images/linuxserver/duplicati "Get your own version badge on microbadger.com")[![](https://images.microbadger.com/badges/image/linuxserver/duplicati.svg)](https://microbadger.com/images/linuxserver/duplicati "Get your own image badge on microbadger.com")[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/duplicati.svg)][hub][![Docker Stars](https://img.shields.io/docker/stars/linuxserver/duplicati.svg)][hub][![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Builders/x86-64/x86-64-duplicati)](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-duplicati/)
23-
24-
[Duplicati][appurl] works with standard protocols like FTP, SSH, WebDAV as well as popular services like Microsoft OneDrive, Amazon Cloud Drive & S3, Google Drive, box.com, Mega, hubiC and many others.
25-
26-
[![duplicati](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/duplicati-icon.png)][appurl]
27-
28-
## Usage
29-
30-
```
31-
docker create \
32-
--name=duplicati \
33-
-v <path to data>:/config \
34-
-v <path to data>:/backups \
35-
-v <path to data>:/source \
36-
-e PGID=<gid> -e PUID=<uid> \
37-
-p 8200:8200 \
38-
linuxserver/duplicati
39-
```
40-
41-
## Parameters
42-
43-
`The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side.
44-
For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container.
45-
So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080
46-
http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.`
47-
48-
49-
50-
* `-p 8200` - the port(s)
51-
* `-v /config` - path for duplicati config files
52-
* `-v /backups` - path to store local backups
53-
* `-v /source` - path to source for files to backup
54-
* `-e PGID` for GroupID - see below for explanation
55-
* `-e PUID` for UserID - see below for explanation
56-
57-
It is based on ubuntu xenial with s6 overlay, for shell access whilst the container is running do `docker exec -it duplicati /bin/bash`.
58-
59-
### User / Group Identifiers
60-
61-
Sometimes when using data 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 the data volume directory on the host is owned by the same user you specify and it will "just work" ™.
62-
63-
In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as below:
64-
65-
```
66-
$ id <dockeruser>
67-
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
68-
```
69-
70-
## Setting up the application
71-
72-
The webui is at `<your ip>:8200` , create backup jobs etc via the webui, for local backups select `/backups` as the destination. For more information see [Duplicati][appurl].
73-
74-
## Info
75-
76-
* Shell access whilst the container is running: `docker exec -it duplicati /bin/bash`
77-
* To monitor the logs of the container in realtime: `docker logs -f duplicati`
78-
79-
* container version number
80-
81-
`docker inspect -f '{{ index .Config.Labels "build_version" }}' duplicati`
82-
83-
* image version number
84-
85-
`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/duplicati`
86-
87-
## Versions
88-
89-
+ **09.12.17:** Fix continuation lines.
90-
+ **31.08.17:** Build only beta or release versions (thanks deasmi).
91-
+ **24.04.17:** Initial Release.
92-
{%- endraw %}
5+
project_url: "https://www.duplicati.com/"
6+
project_logo: "https://github.com/linuxserver/docker-templates/raw/master/linuxserver.io/img/duplicati-icon.png"
7+
project_blurb: "[{{ project_name|capitalize }}]({{ project_url }}) works with standard protocols like FTP, SSH, WebDAV as well as popular services like Microsoft OneDrive, Amazon Cloud Drive & S3, Google Drive, box.com, Mega, hubiC and many others."
8+
project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}"
9+
10+
# supported architectures
11+
available_architectures:
12+
- { arch: "{{ arch_x86_64 }}", tag: "amd64-latest"}
13+
- { arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"}
14+
- { arch: "{{ arch_armhf }}", tag: "arm32v6-latest"}
15+
16+
# container parameters
17+
common_param_env_vars_enabled: true
18+
param_container_name: "{{ project_name }}"
19+
param_usage_include_vols: true
20+
param_volumes:
21+
- { vol_path: "/config", vol_host_path: "</path/to/appdata/config>", desc: "Contains all relevant configuration files." }
22+
- { vol_path: "/backups", vol_host_path: "</path/to/backups>", desc: "Path to store local backups." }
23+
- { vol_path: "/source", vol_host_path: "</path/to/source>", desc: "Path to source for files to backup." }
24+
param_usage_include_ports: true
25+
param_ports:
26+
- { external_port: "8200", internal_port: "8200", port_desc: "http gui" }
27+
param_usage_include_env: true
28+
param_env_vars:
29+
- { env_var: "TZ", env_value: "Europe/London", desc: "Specify a timezone to use EG Europe/London"}
30+
31+
# optional parameters
32+
optional_block_1: false
33+
optional_block_1_items: ""
34+
35+
# application setup block
36+
app_setup_block_enabled: true
37+
app_setup_block: |
38+
The webui is at `<your ip>:8200` , create backup jobs etc via the webui, for local backups select `/backups` as the destination. For more information see [Duplicati]({{project_url}}).
39+
40+
# changelog
41+
changelogs:
42+
- { date: "11.01.19:", desc: "Multi-arch image." }
43+
- { date: "09.12.17:", desc: "Fix continuation lines." }
44+
- { date: "31.08.17:", desc: "Build only beta or release versions (thanks deasmi)." }
45+
- { date: "24.04.17:", desc: "Initial release." }

0 commit comments

Comments
 (0)