Skip to content
This repository was archived by the owner on Jan 3, 2025. It is now read-only.

Commit 836d7bb

Browse files
authored
Merge pull request #32 from thelamer/master
adding dynamic readme
2 parents bd99fc7 + 6247df6 commit 836d7bb

File tree

2 files changed

+206
-160
lines changed

2 files changed

+206
-160
lines changed

README.md

Lines changed: 142 additions & 63 deletions
Original file line numberDiff line numberDiff line change
@@ -1,66 +1,127 @@
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://quassel-irc.org/
6-
[hub]: https://hub.docker.com/r/linuxserver/quassel-core/
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/quassel-core
16-
[![](https://images.microbadger.com/badges/version/linuxserver/quassel-core.svg)](https://microbadger.com/images/linuxserver/quassel-core "Get your own version badge on microbadger.com")[![](https://images.microbadger.com/badges/image/linuxserver/quassel-core.svg)](https://microbadger.com/images/linuxserver/quassel-core "Get your own image badge on microbadger.com")[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/quassel-core.svg)][hub][![Docker Stars](https://img.shields.io/docker/stars/linuxserver/quassel-core.svg)][hub][![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Builders/x86-64/x86-64-quassel-core)](https://ci.linuxserver.io/job/Docker-Builders/job/x86-64/job/x86-64-quassel-core/)
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-
[Quassel IRC][appurl] is a modern, cross-platform, distributed IRC client, meaning that one (or multiple) client(s) can attach to and detach from a central core.
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/quassel-core](https://github.com/linuxserver/docker-quassel-core)
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/quassel-core.svg)](https://microbadger.com/images/linuxserver/quassel-core "Get your own version badge on microbadger.com")
26+
[![](https://images.microbadger.com/badges/image/linuxserver/quassel-core.svg)](https://microbadger.com/images/linuxserver/quassel-core "Get your own version badge on microbadger.com")
27+
![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/quassel-core.svg)
28+
![Docker Stars](https://img.shields.io/docker/stars/linuxserver/quassel-core.svg)
29+
[![Build Status](https://ci.linuxserver.io/buildStatus/icon?job=Docker-Pipeline-Builders/docker-quassel-core/master)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-quassel-core/job/master/)
30+
[![](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/quassel-core/latest/badge.svg)](https://lsio-ci.ams3.digitaloceanspaces.com/linuxserver/quassel-core/latest/index.html)
31+
32+
[Quassel-core](http://quassel-irc.org/) is a modern, cross-platform, distributed IRC client, meaning that one (or multiple) client(s) can attach to and detach from a central core.
1933

2034
This container handles the IRC connection (quasselcore) and requires a desktop client (quasselclient) to be used and configured. It is designed to be always on and will keep your identity present in IRC even when your clients cannot be online. Backlog (history) is downloaded by your client upon reconnection allowing infinite scrollback through time.
2135

22-
[![quassel](http://icons.iconarchive.com/icons/oxygen-icons.org/oxygen/256/Apps-quassel-icon.png)][appurl]
36+
37+
[![quassel-core](http://icons.iconarchive.com/icons/oxygen-icons.org/oxygen/256/Apps-quassel-icon.png)](http://quassel-irc.org/)
38+
39+
## Supported Architectures
40+
41+
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).
42+
43+
Simply pulling `linuxserver/quassel-core` should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
44+
45+
The architectures supported by this image are:
46+
47+
| Architecture | Tag |
48+
| :----: | --- |
49+
| x86-64 | amd64-latest |
50+
| arm64 | arm64v8-latest |
51+
| armhf | arm32v6-latest |
52+
2353

2454
## Usage
2555

56+
Here are some example snippets to help you get started creating a container.
57+
58+
### docker
59+
2660
```
2761
docker create \
28-
--name=quassel-core \
29-
-v /etc/localtime:/etc/localtime:ro \
30-
-v <path to data>:/config \
31-
-e PGID=<gid> -e PUID=<uid> \
32-
-p 4242:4242 \
33-
linuxserver/quassel-core
62+
--name=quassel-core \
63+
-e PUID=1001 \
64+
-e PGID=1001 \
65+
-e TZ=Europe/London \
66+
-p 4242:4242 \
67+
-v <path to data>:/config \
68+
--restart unless-stopped \
69+
linuxserver/quassel-core
3470
```
3571

36-
## Parameters
3772

38-
`The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side.
39-
For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container.
40-
So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080
41-
http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.`
73+
### docker-compose
74+
75+
Compatible with docker-compose v2 schemas.
76+
77+
```
78+
---
79+
version: "2"
80+
services:
81+
quassel-core:
82+
image: linuxserver/quassel-core
83+
container_name: quassel-core
84+
environment:
85+
- PUID=1001
86+
- PGID=1001
87+
- TZ=Europe/London
88+
volumes:
89+
- <path to data>:/config
90+
ports:
91+
- 4242:4242
92+
mem_limit: 4096m
93+
restart: unless-stopped
94+
```
95+
96+
## Parameters
4297

98+
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.
4399

44-
* `-p 4242` - the port quassel-core listens for connections on
45-
* `-v /etc/localtime` for timesync - *optional*
46-
* `-v /config` - database and quassel-core configuration storage
47-
* `-e PGID` for for GroupID - see below for explanation
48-
* `-e PUID` for for UserID - see below for explanation
100+
| Parameter | Function |
101+
| :----: | --- |
102+
| `-p 4242` | The port quassel-core listens for connections on. |
103+
| `-e PUID=1001` | for UserID - see below for explanation |
104+
| `-e PGID=1001` | for GroupID - see below for explanation |
105+
| `-e TZ=Europe/London` | Specify a timezone to use EG Europe/London. |
106+
| `-v /config` | Database and quassel-core configuration storage. |
49107

50-
It is based on alpine linux with s6 overlay, for shell access whilst the container is running do `docker exec -it quassel-core /bin/bash`.
108+
## User / Group Identifiers
51109

52-
### User / Group Identifiers
110+
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`.
53111

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" ™.
112+
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
55113

56-
In this instance `PUID=1001` and `PGID=1001`. To find yours use `id user` as below:
114+
In this instance `PUID=1001` and `PGID=1001`, to find yours use `id user` as below:
57115

58116
```
59-
$ id <dockeruser>
117+
$ id username
60118
uid=1001(dockeruser) gid=1001(dockergroup) groups=1001(dockergroup)
61119
```
62120

63-
## Setting up the application
121+
122+
&nbsp;
123+
## Application Setup
124+
64125
Quassel wiki: [quassel](http://bugs.quassel-irc.org/projects/quassel-irc/wiki)
65126

66127
A great place to host a quassel instance is a VPS, such as [DigitalOcean](https://www.digitalocean.com/?refcode=501c48b34b8c). For $5 a month you can have a 24/7 IRC connection and be up and running in under 55 seconds (or so they claim).
@@ -69,36 +130,54 @@ Once you have the container running, fire up a quassel desktop client and connec
69130

70131
You're now connected to IRC. Let's add you to our [IRC](http://www.linuxserver.io/index.php/irc/) `#linuxserver.io` room on Freenode. Click 'File' > 'Networks' > 'Configure Networks' > 'Add' (under Networks section, not Servers) > 'Use preset' > Select 'Freenode' and then configure your identity using the tabs in the 'Network details' section. Once connected to Freenode, click `#join` and enter `#linuxserver.io`. That's it, you're done.
71132

72-
## Info
73-
74-
Monitor the logs of the container in realtime `docker logs -f quassel-core`.
75133

76-
* container version number
77134

78-
`docker inspect -f '{{ index .Config.Labels "build_version" }}' quassel-core`
135+
## Support Info
79136

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

84163
## Versions
85164

86-
+ **26.01.19:** Add pipeline logic and multi arch.
87-
+ **08.01.19:** Rebase to Ubuntu Bionic and upgrade to Quassel`0.13.0` See [here.](https://quassel-irc.org/node/134)
88-
+ **30.07.18:** Rebase to alpine:3.8 and use buildstage.
89-
+ **03.01.18:** Deprecate cpu_core routine lack of scaling.
90-
+ **09.12.17:** Rebase to alpine:3.7.
91-
+ **26.11.17:** Use cpu core counting routine to speed up build time.
92-
+ **12.07.17:** Add inspect commands to README, move to jenkins build and push.
93-
+ **27.05.17:** Rebase to alpine:3.6.
94-
+ **13.05.17:** Switch to git source.
95-
+ **28.12.16:** Rebase to alpine:3.5.
96-
+ **23.11.16:** Rebase to alpine:edge.
97-
+ **23.09.16:** Use QT5 dependencies (thanks bauerj).
98-
+ **10.09.16:** Add layer badges to README.
99-
+ **28.08.16:** Add badges to README.
100-
+ **10.08.16:** Rebase to xenial
101-
+ **14.10.15:** Removed the webui, turned out to be to unstable for most usecases.
102-
+ **01.09.15:** Fixed mistake in README
103-
+ **30.07.15:** Switched to internal baseimage, and fixed a bug with updating the webinterface.
104-
+ **06.07.15:** Enabled BLOWFISH encryption and added a (optional) webinterface, for the times you dont have access to your client.
165+
* **26.01.19:** - Add pipeline logic and multi arch.
166+
* **08.01.19:** - Rebase to Ubuntu Bionic and upgrade to Quassel`0.13.0` See [here.](https://quassel-irc.org/node/134).
167+
* **30.07.18:** - Rebase to alpine:3.8 and use buildstage.
168+
* **03.01.18:** - Deprecate cpu_core routine lack of scaling.
169+
* **09.12.17:** - Rebase to alpine:3.7.
170+
* **26.11.17:** - Use cpu core counting routine to speed up build time.
171+
* **12.07.17:** - Add inspect commands to README, move to jenkins build and push.
172+
* **27.05.17:** - Rebase to alpine:3.6.
173+
* **13.05.17:** - Switch to git source.
174+
* **28.12.16:** - Rebase to alpine:3.5.
175+
* **23.11.16:** - Rebase to alpine:edge.
176+
* **23.09.16:** - Use QT5 dependencies (thanks bauerj).
177+
* **10.09.16:** - Add layer badges to README.
178+
* **28.08.16:** - Add badges to README.
179+
* **10.08.16:** - Rebase to xenial.
180+
* **14.10.15:** - Removed the webui, turned out to be to unstable for most usecases.
181+
* **01.09.15:** - Fixed mistake in README.
182+
* **30.07.15:** - Switched to internal baseimage, and fixed a bug with updating the webinterface.
183+
* **06.07.15:** - Enabled BLOWFISH encryption and added a (optional) webinterface, for the times you dont have access to your client.

0 commit comments

Comments
 (0)