Portainer Templates logo

Portainer Templates

Pidgin Pidgin

IrcChat

Pidgin is a chat program which lets you log into accounts on multiple chat networks simultaneously. This means that you can be chatting with friends on XMPP and sitting in an IRC channel at the same time.

Image details

Pulls: 69.9k
Architectures: amd64, arm64
Image size: 709 MB
Latest: 2.14.14
User: linuxserverci
Created: May 15, 2021
Updated: 5 days ago
Status: active

Configuration

Type
Container
Platform
linux
Image
linuxserver/pidgin:latest
Ports
3000:3000/tcp3001:3001/tcp
Volumes
/config : /srv/lsio/pidgin/config
Env vars
PUID=1000PGID=1000TZ=Etc/UTC
Restart
unless-stopped

Template by technorabilia

Notes

Portainer App Templates by Technorabilia, based on data provided by LinuxServer.io.

Ensure to create the following volume directories on the host file system, or modify the paths in the volume mapping section under the advanced options below, as needed.

mkdir -p /srv/lsio/pidgin/config

Installation

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select the app you wish to deploy, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo

docker run -d --name Pidgin \
  -p 3000:3000/tcp \
  -p 3001:3001/tcp \
  -e 'PUID=1000' \
  -e 'PGID=1000' \
  -e 'TZ=Etc/UTC' \
  -v /srv/lsio/pidgin/config:/config \
  --restart=unless-stopped \
  linuxserver/pidgin:latest

Save this file as compose.yaml and run docker compose up -d
Use this only as a guide.

services:
  pidgin:
    image: linuxserver/pidgin:latest
    ports:
      - 3000:3000/tcp
      - 3001:3001/tcp
    volumes:
      - /srv/lsio/pidgin/config:/config
    environment:
      PUID: '1000'
      PGID: '1000'
      TZ: Etc/UTC
    restart: unless-stopped

Save this file as pidgin-stack.yml, then from a manager node, run docker stack deploy -c pidgin-stack.yml pidgin

version: '3.8'
services:
  pidgin:
    image: linuxserver/pidgin:latest
    ports:
      - 3000:3000/tcp
      - 3001:3001/tcp
    volumes:
      - /srv/lsio/pidgin/config:/config
    environment:
      PUID: '1000'
      PGID: '1000'
      TZ: Etc/UTC
    deploy:
      restart_policy:
        condition: any

Save each file below into a folder, then run kubectl apply -f .
Written for k3s, but works on any cluster: bind mounts use hostPath, named volumes get a persistent volume claim, and ports are exposed via a LoadBalancer service.

pidgin-deployment.yaml

apiVersion: apps/v1
kind: Deployment
metadata:
  name: pidgin
  labels:
    app: pidgin
spec:
  replicas: 1
  selector:
    matchLabels:
      app: pidgin
  template:
    metadata:
      labels:
        app: pidgin
    spec:
      containers:
        - name: pidgin
          image: linuxserver/pidgin:latest
          env:
            - name: PUID
              value: '1000'
            - name: PGID
              value: '1000'
            - name: TZ
              value: Etc/UTC
          ports:
            - containerPort: 3000
              protocol: TCP
            - containerPort: 3001
              protocol: TCP
          volumeMounts:
            - name: pidgin-data-0
              mountPath: /config
      volumes:
        - name: pidgin-data-0
          hostPath:
            path: /srv/lsio/pidgin/config

pidgin-service.yaml

apiVersion: v1
kind: Service
metadata:
  name: pidgin
spec:
  type: LoadBalancer
  selector:
    app: pidgin
  ports:
    - name: 3000-tcp
      port: 3000
      targetPort: 3000
      protocol: TCP
    - name: 3001-tcp
      port: 3001
      targetPort: 3001
      protocol: TCP

Save this file as ~/.config/containers/systemd/pidgin.container

[Unit]
Description=Pidgin

[Container]
Image=linuxserver/pidgin:latest
ContainerName=pidgin
PublishPort=3000:3000/tcp
PublishPort=3001:3001/tcp
Environment=PUID=1000
Environment=PGID=1000
Environment=TZ=Etc/UTC
Volume=/srv/lsio/pidgin/config:/config

[Service]
Restart=always

[Install]
WantedBy=default.target

Then reload systemd and start the service:

systemctl --user daemon-reload
systemctl --user start pidgin

For a system-wide service, use /etc/containers/systemd/ and drop --user.

For more installation options, see the Documentation in our GitHub repo

linuxserver/pidgin

This readme has been truncated from the full version found HERE

Pidgin is a chat program which lets you log into accounts on multiple chat networks simultaneously. This means that you can be chatting with friends on XMPP and sitting in an IRC channel at the same time.

Application Setup

The application can be accessed at:
  • https://yourhost:3001/

This Pidgin installation comes with default chat plugins plus a series of third party ones. Please note that the third party plugins for the most part are not simply plug and play, you will need to reference their documentation and possibly generate oauth tokens along with other workarounds. Third party plugins are always in a state of constant development do not expect every single native feature to work flawlessly. To ease integration with some third party plugins we include Firefox in this image to allow you to fill out captchas or pre-auth before loading your credentials into the program, simply right click the desktop to launch it.

Usage

docker run -d \
  --name=pidgin \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Etc/UTC \
  -p 3000:3000 \
  -p 3001:3001 \
  -v /path/to/config:/config \
  --shm-size="1gb" \
  --restart unless-stopped \
  lscr.io/linuxserver/pidgin:latest

Serve Pidgin on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying pidgin.example.com to http://Pidgin:3000

Add this to your Caddyfile

pidgin.example.com {
	reverse_proxy http://Pidgin:3000
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs Pidgin
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:3000 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :3000
  • Stop the other service, or pick a different host port. In 3000:3000 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:3000. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, Pidgin can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 3000

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

  • Fix the ownership: sudo chown -R 1000:1000 /srv/lsio/pidgin/config
  • Or set the PUID and PGID variables (defaults 1000:1000) to match your own user, found with id $USER

Image won't pull

Test the pull directly on the host: docker pull linuxserver/pidgin:latest

  • "manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • This image supports: amd64, arm64
  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect Pidgin --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

Similar apps

Altus Altus ChatFerdium (container) Ferdium (container) ChatLimnoria Limnoria IrcMurmur Murmur ChatNgircd Ngircd IrcSignal Signal ChatTelegram Telegram ChatThelounge Thelounge Irc