Skip to content

Commit 68a3e51

Browse files
j0nnymoej0nnymoe
authored
Merge pull request #19 from IronicBadger/master
dynamic readme
2 parents 4bb2fff + bde6cce commit 68a3e51

2 files changed

Lines changed: 184 additions & 162 deletions

File tree

‎README.md‎

Lines changed: 134 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -1,96 +1,167 @@
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]: http://piwigo.org/
6-
[hub]: https://hub.docker.com/r/linuxserver/piwigo/
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/piwigo
16-
[![](https://images.microbadger.com/badges/version/linuxserver/piwigo.svg)](https://microbadger.com/images/linuxserver/piwigo "Get your own version badge on microbadger.com")[![](https://images.microbadger.com/badges/image/linuxserver/piwigo.svg)](https://microbadger.com/images/linuxserver/piwigo "Get your own image badge on microbadger.com")[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/piwigo.svg)][hub][![Docker Stars](https://img.shields.io/docker/stars/linuxserver/piwigo.svg)][hub][![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Builders/x86-64/x86-64-piwigo)](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-piwigo/)
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-
Piwigo is a photo gallery software for the web that comes with powerful features to publish and manage your collection of pictures.
17+
# PSA: Changes are happening
18+
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/piwigo](https://github.com/linuxserver/docker-piwigo)
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/piwigo.svg)](https://microbadger.com/images/linuxserver/piwigo "Get your own version badge on microbadger.com")
26+
[![](https://images.microbadger.com/badges/image/linuxserver/piwigo.svg)](https://microbadger.com/images/linuxserver/piwigo "Get your own version badge on microbadger.com")
27+
![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/piwigo.svg)
28+
![Docker Stars](https://img.shields.io/docker/stars/linuxserver/piwigo.svg)
29+
[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-piwigo/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-piwigo/job/master/)
30+
[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/piwigo/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/piwigo/latest/index.html)
31+
32+
[Piwigo](http://piwigo.org/) is a photo gallery software for the web that comes with powerful features to publish and manage your collection of pictures.
33+
34+
[![piwigo](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/piwigo-banner.png)](http://piwigo.org/)
35+
36+
## Supported Architectures
37+
38+
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).
39+
40+
Simply pulling `linuxserver/piwigo` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
41+
42+
The architectures supported by this image are:
43+
44+
| Architecture | Tag |
45+
| :----: | --- |
46+
| x86-64 | amd64-latest |
47+
| arm64 | arm64v8-latest |
48+
| armhf | arm32v6-latest |
1949

20-
[![piwigo](https://raw.githubusercontent.com/linuxserver/docker-templates/master/linuxserver.io/img/piwigo-banner.png)][appurl]
2150

2251
## Usage
2352

53+
Here are some example snippets to help you get started creating a container.
54+
55+
### docker
56+
2457
```
2558
docker create \
26-
--name=piwigo \
27-
-v /etc/localtime:/etc/localtime:ro \
28-
-v <path to data>:/config \
29-
-e PGID=<gid> -e PUID=<uid> \
30-
-e TZ=<timezone> \
31-
-p 80:80 \
32-
linuxserver/piwigo
59+
--name=piwigo \
60+
-e PUID=1001 \
61+
-e PGID=1001 \
62+
-e TZ=Europe/London \
63+
-p 80:80 \
64+
-v </path/to/appdata/config>:/config \
65+
--restart unless-stopped \
66+
linuxserver/piwigo
3367
```
3468

35-
## Parameters
36-
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.`
4169

70+
### docker-compose
4271

43-
* `-p 80` - webui port *see note below*
44-
* `-v /etc/localtime` for timesync - *optional*
45-
* `-v /config` - folder to store appdata and config file for piwigo
46-
* `-e PGID` for GroupID - see below for explanation
47-
* `-e PUID` for UserID - see below for explanation
48-
* `-e TZ` for setting timezone information, eg Europe/London
72+
Compatible with docker-compose v2 schemas.
4973

50-
It is based on alpine linux with s6 overlay, for shell access whilst the container is running do `docker exec -it piwigo /bin/bash`.
74+
```
75+
---
76+
version: "2"
77+
services:
78+
piwigo:
79+
image: linuxserver/piwigo
80+
container_name: piwigo
81+
environment:
82+
- PUID=1001
83+
- PGID=1001
84+
- TZ=Europe/London
85+
volumes:
86+
- </path/to/appdata/config>:/config
87+
ports:
88+
- 80:80
89+
mem_limit: 4096m
90+
restart: unless-stopped
91+
```
5192

52-
### User / Group Identifiers
93+
## Parameters
5394

54-
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" ™.
95+
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.
5596

56-
In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as below:
97+
| Parameter | Function |
98+
| :----: | --- |
99+
| `-p 80` | Application WebUI |
100+
| `-e PUID=1001` | for UserID - see below for explanation |
101+
| `-e PGID=1001` | for GroupID - see below for explanation |
102+
| `-e TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
103+
| `-v /config` | Configuration files. |
57104

58-
```
59-
$ id <dockeruser>
60-
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
61-
```
105+
## User / Group Identifiers
62106

63-
## Setting up the application
107+
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`.
64108

65-
You must create a user and database for piwigo to use in a mysql/mariadb server. In the setup page for database, use the ip address rather than hostname....
109+
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
66110

67-
A basic nginx configuration file can be found in /config/nginx/site-confs , edit the file to enable ssl (port 443 by default), set servername etc..
68-
Self-signed keys are generated the first time you run the container and can be found in /config/keys , if needed, you can replace them with your own.
111+
In this instance `PUID=1001` and `PGID=1001`, to find yours use `id user` as below:
69112

70-
The easiest way to edit the configuration file is to enable local files editor from the plugins page and use it to configure email settings etc....
113+
```
114+
$ id username
115+
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
116+
```
71117

72118

73-
## Info
119+
&nbsp;
120+
## Application Setup
74121

75-
* To update piwigo if required, update via the webui
76-
* To monitor the logs of the container in realtime `docker logs -f piwigo`.
122+
* You must create a user and database for piwigo to use in a mysql/mariadb server.
123+
* In the setup page for database, use the ip address rather than hostname.
124+
* A basic nginx configuration file can be found in `/config/nginx/site-confs`, edit the file to enable ssl (port 443 by default), set servername etc.
125+
* Self-signed keys are generated the first time you run the container and can be found in `/config/keys`, if needed, you can replace them with your own.
126+
* The easiest way to edit the configuration file is to enable local files editor from the plugins page and use it to configure email settings etc.
77127

78-
* container version number
79128

80-
`docker inspect -f '{{ index .Config.Labels "build_version" }}' piwigo`
129+
## Support Info
81130

131+
* Shell access whilst the container is running: `docker exec -it piwigo /bin/bash`
132+
* To monitor the logs of the container in realtime: `docker logs -f piwigo`
133+
* container version number
134+
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' piwigo`
82135
* image version number
83-
84-
`docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/piwigo`
136+
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/piwigo`
137+
138+
## Updating Info
139+
140+
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.
141+
142+
Below are the instructions for updating containers:
143+
144+
### Via Docker Run/Create
145+
* Update the image: `docker pull linuxserver/piwigo`
146+
* Stop the running container: `docker stop piwigo`
147+
* Delete the container: `docker rm piwigo`
148+
* 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)
149+
* Start the new container: `docker start piwigo`
150+
* You can also remove the old dangling images: `docker image prune`
151+
152+
### Via Docker Compose
153+
* Update the image: `docker-compose pull linuxserver/piwigo`
154+
* Let compose update containers as necessary: `docker-compose up -d`
155+
* You can also remove the old dangling images: `docker image prune`
85156

86157
## Versions
87158

88-
+ **28.01.19:** Rebase to alpine linux 3.8 , add pipeline logic and multi arch.
89-
+ **25.01.18:** Rebase to alpine linux 3.7.
90-
+ **25.05.17:** Rebase to alpine linux 3.6.
91-
+ **03.05.17:** Use repo pinning to better solve dependencies, use repo version of php7-imagick.
92-
+ **20.04.17:** Add php7-exif package, thanks iiska
93-
+ **23.02.17:** Rebase to alpine linux 3.5 and nginx.
94-
+ **14.10.16:** Add version layer information.
95-
+ **10.09.16:** Add layer badges to README.
96-
+ **29.08.15:** Initial Release.
159+
* **28.01.19:** - Rebase to alpine linux 3.8 , add pipeline logic and multi arch.
160+
* **25.01.18:** - Rebase to alpine linux 3.7.
161+
* **25.05.17:** - Rebase to alpine linux 3.6.
162+
* **03.05.17:** - Use repo pinning to better solve dependencies, use repo version of php7-imagick.
163+
* **20.04.17:** - Add php7-exif package, thanks iiska
164+
* **23.02.17:** - Rebase to alpine linux 3.5 and nginx.
165+
* **14.10.16:** - Add version layer information.
166+
* **10.09.16:** - Add layer badges to README.
167+
* **29.08.15:** - Initial Release.

0 commit comments

Comments
 (0)