docker-documentation/images/docker-pidgin.md

title
pidgin

linuxserver/pidgin

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.

Supported Architectures

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 and our announcement here.

Simply pulling lscr.io/linuxserver/pidgin should retrieve the correct image for your arch, but you can also pull specific arch images via tags.

The architectures supported by this image are:

Architecture	Tag
x86-64	latest
arm64	arm64v8-latest
armhf	arm32v7-latest

Application Setup

The application can be accessed at:

• http://yourhost:3000/

By default the user/pass is abc/abc, if you change your password or want to login manually to the GUI session for any reason use the following link:

• http://yourhost:3000/?login=true

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.

• Bonjour- Default XMPP style plugin
• Discord- Provided by purple-discord
• Facebook- Provided by purple-facebook
• Gadu-Gadu- Default libgadu plugin
• Google Talk- Provided by purple-hangouts
• GroupWise- Default GroupWise plugin
• Hangouts- Provided by purple-hangouts
• ICQ (WIM)- Provided by icyque
• IRC- Default IRC plugin
• Instagram- Provided by purple-instagram
• Office Comminicator (SIPE)- Provided by SIPE Project
• Rocket.chat- Provided by purple-rocketchat
• SIMPLE- Default plugin
• Skype (HTTP)- Provided by skype4pidgin
• Slack- Provided by slack-libpurple
• Telegram- Provided by telegram-purple
• XMPP- Default XMPP plugin
• Zephyr- Default project Athena plugin

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.

docker-compose (recommended, click here for more info)

---
version: "2.1"
services:
  pidgin:
    image: lscr.io/linuxserver/pidgin
    container_name: pidgin
    environment:
      - PUID=1000
      - PGID=1000
      - TZ=Europe/London
    volumes:
      - /path/to/config:/config
    ports:
      - 3000:3000
    restart: unless-stopped

docker cli (click here for more info)

docker run -d \
  --name=pidgin \
  -e PUID=1000 \
  -e PGID=1000 \
  -e TZ=Europe/London \
  -p 3000:3000 \
  -v /path/to/config:/config \
  --restart unless-stopped \
  lscr.io/linuxserver/pidgin

Parameters

Docker 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.

Ports (-p)

Parameter	Function
3000	Pidgin desktop gui.

Environment Variables (-e)

Env	Function
PUID=1000	for UserID - see below for explanation
PGID=1000	for GroupID - see below for explanation
TZ=Europe/London	Specify a timezone to use EG Europe/London.

Volume Mappings (-v)

Volume	Function
/config	Users home directory in the container, stores local files and settings

Miscellaneous Options

Parameter	Function

Environment variables from files (Docker secrets)

You can set any environment variable from a file by using a special prepend FILE__.

As an example:

-e FILE__PASSWORD=/run/secrets/mysecretpassword

Will set the environment variable PASSWORD based on the contents of the /run/secrets/mysecretpassword file.

Umask for running applications

For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.

User / Group Identifiers

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.

Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.

In this instance PUID=1000 and PGID=1000, to find yours use id user as below:

  $ id username
    uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

Docker Mods

We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.

Support Info

• Shell access whilst the container is running:
  • docker exec -it pidgin /bin/bash
• To monitor the logs of the container in realtime:
  • docker logs -f pidgin
• Container version number
  • docker inspect -f '{{ index .Config.Labels "build_version" }}' pidgin
• Image version number
  • docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/pidgin

Versions

• 26.09.21: - Rebase to Alpine 3.14.
• 14.05.21: - Initial release.