Bot Updating Documentation

pull/38/head
LinuxServer-CI 2021-05-15 04:24:33 +01:00
rodzic b0b54e0884
commit 44f4e659d7
1 zmienionych plików z 179 dodań i 0 usunięć

Wyświetl plik

@ -0,0 +1,179 @@
---
title: pidgin
---
<!-- DO NOT EDIT THIS FILE MANUALLY -->
<!-- Please read the https://github.com/linuxserver/docker-pidgin/blob/master/.github/CONTRIBUTING.md -->
# [linuxserver/pidgin](https://github.com/linuxserver/docker-pidgin)
[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-pidgin.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-pidgin)
[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-pidgin.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-pidgin/releases)
[![GitHub Package Repository](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub%20Package&logo=github)](https://github.com/linuxserver/docker-pidgin/packages)
[![GitLab Container Registry](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab)](https://gitlab.com/linuxserver.io/docker-pidgin/container_registry)
[![MicroBadger Layers](https://img.shields.io/microbadger/layers/linuxserver/pidgin.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge)](https://microbadger.com/images/linuxserver/pidgin "Get your own version badge on microbadger.com")
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/pidgin.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/pidgin)
[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/pidgin.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/pidgin)
[![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-pidgin%2Fjob%2Fmaster%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-pidgin/job/master/)
[![LSIO CI](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=CI&query=CI&url=https%3A%2F%2Fci-tests.linuxserver.io%2Flinuxserver%2Fpidgin%2Flatest%2Fci-status.yml)](https://ci-tests.linuxserver.io/linuxserver/pidgin/latest/index.html)
[Pidgin](https://pidgin.im/) 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](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
Simply pulling `ghcr.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](https://github.com/EionRobb/purple-discord)
* Facebook- Provided by [purple-facebook](https://github.com/dequis/purple-facebook)
* Gadu-Gadu- Default libgadu plugin
* Google Talk- Provided by [purple-hangouts](https://github.com/EionRobb/purple-hangouts)
* GroupWise- Default GroupWise plugin
* Hangouts- Provided by [purple-hangouts](https://github.com/EionRobb/purple-hangouts)
* ICQ (WIM)- Provided by [icyque](https://github.com/EionRobb/icyque)
* IRC- Default IRC plugin
* Instagram- Provided by [purple-instagram](https://github.com/EionRobb/purple-instagram)
* Office Comminicator (SIPE)- Provided by [SIPE Project](https://sipe.sourceforge.io/)
* Rocket.chat- Provided by [purple-rocketchat](https://github.com/EionRobb/purple-rocketchat)
* SIMPLE- Default plugin
* Skype (HTTP)- Provided by [skype4pidgin](https://github.com/EionRobb/skype4pidgin)
* Slack- Provided by [slack-libpurple](https://github.com/EionRobb/slack-libpurple)
* Telegram- Provided by [telegram-purple](https://github.com/majn/telegram-purple)
* XMPP- Default XMPP plugin
* Zephyr- Default project Athena plugin
## Usage
Here are some example snippets to help you get started creating a container from this image.
### docker-compose ([recommended](https://docs.linuxserver.io/general/docker-compose))
Compatible with docker-compose v2 schemas.
```yaml
---
version: "2.1"
services:
pidgin:
image: ghcr.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
```bash
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 \
ghcr.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 |
## Environment variables from files (Docker secrets)
You can set any environment variable from a file by using a special prepend `FILE__`.
As an example:
```bash
-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](https://en.wikipedia.org/wiki/Umask) 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:
```bash
$ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
```
## Docker Mods
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pidgin&query=%24.mods%5B%27pidgin%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=pidgin "view available mods for this container.") [![Docker Universal Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
We publish various [Docker Mods](https://github.com/linuxserver/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" }}' ghcr.io/linuxserver/pidgin`
## Versions
* **14.05.21:** - Initial release.