Skip to content

weechat/weechat-container

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

69 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Containerized WeeChat

Build Status

Build of WeeChat images using Docker (default) or Podman.

Requirements

The following packages are required to build images:

  • Docker or Podman

Optional dependencies:

  • Python ≥ 3.6 if you use the provided Makefile or build.py script

Image types

Images are based on Debian or Alpine (smaller size, with same features):

  • Debian:
    • debian (~ 353 MB)
    • debian-slim: slim version (~ 117 MB)
  • Alpine:
    • alpine (~ 213 MB)
    • alpine-slim: slim version (~ 39 MB)

The slim version includes all plugins except these ones:

  • script manager (command /script)
  • scripting languages: perl, python, ruby, lua, tcl, guile, php
  • spell

Install and run with Docker Hub

You can install and run directly the latest version from the Docker Hub:

docker run -it weechat/weechat

Or the Alpine version:

docker run -it weechat/weechat:latest-alpine

For a specific WeeChat version (Debian):

docker run -it weechat/weechat:4.3.2

Run with custom home directories on host to persist data (WeeChat ≥ 3.2, using XDG directories):

mkdir -p ~/.weechat-container/config ~/.weechat-container/data ~/.weechat-container/cache
chmod 777 ~/.weechat-container/config ~/.weechat-container/data ~/.weechat-container/cache
docker run -it -v $HOME/.weechat-container/config:/home/user/.config/weechat -v $HOME/.weechat-container/data:/home/user/.local/share/weechat -v $HOME/.weechat-container/cache:/home/user/.cache/weechat weechat/weechat

Run with a custom single home directory on host to persist data (any WeeChat version):

mkdir -p ~/.weechat-container
chmod 777 ~/.weechat-container
docker run -it -v $HOME/.weechat-container:/home/user/.weechat weechat/weechat weechat -d /home/user/.weechat

Build

A Makefile is provided and supports these variables:

  • BUILDER: the tool to build the image: docker, podman or any equivalent tool (default is docker)
  • VERSION: the WeeChat version to build (default is latest which is the latest stable version, use devel for development version, which is built every day).

Build a Debian-based image with latest stable version of WeeChat:

make debian

Build all images with latest stable version of WeeChat:

make all-images

Build an Alpine-based image with Podman, slim version, WeeChat 4.3.2:

make BUILDER=podman VERSION=4.3.2 alpine-slim

Build a Debian-based image with WeeChat 4.3.2, directly with docker:

docker build -f debian/Containerfile --build-arg VERSION=4.3.2 .

Copyright

Copyright © 2021-2024 Sébastien Helleu

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see https://www.gnu.org/licenses/.