Skip to content

Commit 2795f12

Browse files
committed
readme template filled out
1 parent 467bae0 commit 2795f12

2 files changed

Lines changed: 52 additions & 0 deletions

File tree

READMETEMPLATE.md

Lines changed: 49 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
![http://linuxserver.io](http://www.linuxserver.io/wp-content/uploads/2015/06/linuxserver_medium.png)
2+
3+
The [LinuxServer.io](http://linuxserver.io) team brings you another quality container release featuring auto-update on startup, easy user mapping and community support. Be sure to checkout our [forums](http://forum.linuxserver.io) or for real-time support our [IRC](http://www.linuxserver.io/index.php/irc/) on freenode at `#linuxserver.io`.
4+
5+
# linuxserver/piwigo
6+
7+
Piwigo is a photo gallery software for the web that comes with powerful features to publish and manage your collection of pictures.
8+
[Piwigo](http://piwigo.org/)
9+
10+
## Usage
11+
12+
```
13+
docker create --name=piwigo -v /etc/localtime:/etc/localtime:ro -v <path to data>:/config -e PGID=<gid> -e PUID=<uid> -p 80:80 linuxserver/piwigo
14+
```
15+
16+
**Parameters**
17+
18+
* `-p 80` - webui port *see note below*
19+
* `-v /etc/localhost` for timesync - *optional*
20+
* `-v /config` - folder to store appdata and config file for piwigo
21+
* `-e PGID` for GroupID - see below for explanation
22+
* `-e PUID` for UserID - see below for explanation
23+
24+
It is based on phusion-baseimage with ssh removed, for shell access whilst the container is running do `docker exec -it piwigo /bin/bash`.
25+
26+
### User / Group Identifiers
27+
28+
**TL;DR** - The `PGID` and `PUID` values set the user / group you'd like your container to 'run as' to the host OS. This can be a user you've created or even root (not recommended).
29+
30+
Part of what makes our containers work so well is by allowing you to specify your own `PUID` and `PGID`. This avoids nasty permissions errors with relation to data volumes (`-v` flags). When an application is installed on the host OS it is normally added to the common group called users, Docker apps due to the nature of the technology can't be added to this group. So we added this feature to let you easily choose when running your containers.
31+
32+
## Setting up the application
33+
A basic apache configuration file can be found in /config/apache/site-confs , edit the file to enable ssl (port 443 by default), set servername etc..
34+
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.
35+
36+
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....
37+
38+
39+
## Updates
40+
41+
* To update the packages like apache etc `docker restart piwigo`.
42+
* To update piwigo if required, update via the webui
43+
* To monitor the logs of the container in realtime `docker logs -f piwigo`.
44+
45+
46+
47+
## Versions
48+
49+
+ **29.08.2015:** Initial Release.

init/60_set_the_site.sh

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11,3 +11,6 @@ rm -rf /tmp/piwigo /tmp/piwigo.zip
1111
chown -R abc:abc /config/www/gallery
1212
fi
1313

14+
if [ ! -f "/config/www/gallery/local/config/config.inc.php" ]; then
15+
cp /config/www/gallery/include/config_default.inc.php /config/www/gallery/local/config/config.inc.php
16+
fi

0 commit comments

Comments
 (0)