Awesome LSIO¶
Administration¶
| Container | Description |
|---|---|
| doublecommander | Double Commander is a free cross platform open source file manager with two panels side by side. It is inspired by Total Commander and features some new ideas. |
| endlessh | endlessh is an SSH tarpit that very slowly sends an endless, random SSH banner. It keeps SSH clients locked up for hours or even days at a time. The purpose is to put your real SSH server on another port and then let the script kiddies get stuck in this tarpit instead of bothering a real server. |
| ldap-auth | ldap-auth software is for authenticating users who request protected resources from servers proxied by nginx. It includes a daemon (ldap-auth) that communicates with an authentication server, and a webserver daemon that generates an authentication cookie based on the user’s credentials. The daemons are written in Python for use with a Lightweight Directory Access Protocol (LDAP) authentication server (OpenLDAP or Microsoft Windows Active Directory 2003 and 2012). |
| netbootxyz | netbootxyz is a way to PXE boot various operating system installers or utilities from one place within the BIOS without the need of having to go retrieve the media to run the tool. iPXE is used to provide a user friendly menu from within the BIOS that lets you easily choose the operating system you want along with any specific types of versions or bootable flags. |
| netbox | netbox is an IP address management (IPAM) and data center infrastructure management (DCIM) tool. Initially conceived by the network engineering team at DigitalOcean, NetBox was developed specifically to address the needs of network and infrastructure engineers. It is intended to function as a domain-specific source of truth for network operations. |
| openssh-server | openssh-server is a sandboxed environment that allows ssh access without giving keys to the entire server. |
| snipe-it | snipe-it makes asset management easy. It was built by people solving real-world IT and asset management problems, and a solid UX has always been a top priority. Straightforward design and bulk actions mean getting things done faster. |
Audiobooks¶
| Container | Description |
|---|---|
| booksonic-air | booksonic-air is a platform for accessing the audiobooks you own wherever you are. At the moment the platform consists of |
Automation¶
| Container | Description |
|---|---|
| domoticz | domoticz is a Home Automation System that lets you monitor and configure various devices like: Lights, Switches, various sensors/meters like Temperature, Rain, Wind, UV, Electra, Gas, Water and much more. Notifications/Alerts can be sent to any mobile device. |
| habridge | habridge emulates Philips Hue API to other home automation gateways such as an Amazon Echo/Dot Gen 1 (gen 2 has issues discovering ha-bridge) or other systems that support Philips Hue. The Bridge handles basic commands such as "On", "Off" and "brightness" commands of the hue protocol. This bridge can control most devices that have a distinct API. |
| homeassistant | Home Assistant Core - Open source home automation that puts local control and privacy first. Powered by a worldwide community of tinkerers and DIY enthusiasts. Perfect to run on a Raspberry Pi or a local server. |
| kanzi | kanzi, formerly titled Kodi-Alexa, this custom skill is the ultimate voice remote control for navigating Kodi. It can do anything you can think of (100+ intents). This container also contains lexigram-cli to setup Kanzi with an Amazon Developer Account and automatically deploy it to Amazon. |
Backup¶
| Container | Description |
|---|---|
| duplicati | duplicati works with standard protocols like FTP, SSH, WebDAV as well as popular services like Microsoft OneDrive, Amazon Cloud Drive & S3, Google Drive, box.com, Mega, hubiC and many others. |
| resilio-sync | resilio-sync (formerly BitTorrent Sync) uses the BitTorrent protocol to sync files and folders between all of your devices. There are both free and paid versions, this container supports both. There is an official sync image but we created this one as it supports user mapping to simplify permissions for volumes. |
| rsnapshot | rsnapshot is a filesystem snapshot utility based on rsync. rsnapshot makes it easy to make periodic snapshots of local machines, and remote machines over ssh. The code makes extensive use of hard links whenever possible, to greatly reduce the disk space required." |
| syncthing | syncthing replaces proprietary sync and cloud services with something open, trustworthy and decentralized. Your data is your data alone and you deserve to choose where it is stored, if it is shared with some third party and how it's transmitted over the Internet. |
Books¶
| Container | Description |
|---|---|
| calibre | calibre is a powerful and easy to use e-book manager. Users say it’s outstanding and a must-have. It’ll allow you to do nearly everything and it takes things a step beyond normal e-book software. It’s also completely free and open source and great for both casual users and computer experts. |
| calibre-web | calibre-web is a web app providing a clean interface for browsing, reading and downloading eBooks using an existing Calibre database. It is also possible to integrate google drive and edit metadata and your calibre library through the app itself. |
| cops | cops by Sébastien Lucas, stands for Calibre OPDS (and HTML) Php Server. |
| lazylibrarian | lazylibrarian is a program to follow authors and grab metadata for all your digital reading needs. It uses a combination of Goodreads Librarything and optionally GoogleBooks as sources for author info and book info. This container is based on the DobyTang fork. |
| mylar3 | mylar3 is an automated Comic Book downloader (cbr/cbz) for use with NZB and torrents written in python. It supports SABnzbd, NZBGET, and many torrent clients in addition to DDL. |
| readarr | readarr - Book Manager and Automation (Sonarr for Ebooks) |
| ubooquity | ubooquity is a free, lightweight and easy-to-use home server for your comics and ebooks. Use it to access your files from anywhere, with a tablet, an e-reader, a phone or a computer. |
Cloud¶
| Container | Description |
|---|---|
| nextcloud | nextcloud gives you access to all your files wherever you are. |
Crypto¶
| Container | Description |
|---|---|
| gmail-order-bot | gmail-order-bot - A bot used to leverage a Gmail account as an order messaging service to consume email orders from Nano Checkout and process them using any custom logic you choose. |
| nano | nano is a digital payment protocol designed to be accessible and lightweight, with a focus on removing inefficiencies present in other cryptocurrencies. With ultrafast transactions and zero fees on a secure, green and decentralized network, this makes Nano ideal for everyday transactions. |
| nano-discord-bot | nano-discord-bot - A bot used to hook into a self hosted Nano RPC endpoint and discord server to Distribute funds from a faucet account. |
| nano-wallet | nano-wallet is a digital payment protocol designed to be accessible and lightweight, with a focus on removing inefficiencies present in other cryptocurrencies. With ultrafast transactions and zero fees on a secure, green and decentralized network, this makes Nano ideal for everyday transactions. |
DNS¶
| Container | Description |
|---|---|
| adguardhome-sync | adguardhome-sync is a tool to synchronize AdGuardHome config to replica instances. |
| ddclient | ddclient is a Perl client used to update dynamic DNS entries for accounts on Dynamic DNS Network Service Provider. It was originally written by Paul Burry and is now mostly by wimpunk. It has the capability to update more than just dyndns and it can fetch your WAN-ipaddress in a few different ways. |
| duckdns | duckdns is a free service which will point a DNS (sub domains of duckdns.org) to an IP of your choice. The service is completely free, and doesn't require reactivation or forum posts to maintain its existence. |
Dashboard¶
| Container | Description |
|---|---|
| heimdall | heimdall is a way to organise all those links to your most used web sites and web applications in a simple way. |
Databases¶
| Container | Description |
|---|---|
| mariadb | mariadb is one of the most popular database servers. Made by the original developers of MySQL. |
| mysql-workbench | MySQL Workbench is a unified visual tool for database architects, developers, and DBAs. MySQL Workbench provides data modeling, SQL development, and comprehensive administration tools for server configuration, user administration, backup, and much more. |
| phpmyadmin | phpmyadmin is a free software tool written in PHP, intended to handle the administration of MySQL over the Web. phpMyAdmin supports a wide range of operations on MySQL and MariaDB. |
| sqlitebrowser | DB Browser for SQLite is a high quality, visual, open source tool to create, design, and edit database files compatible with SQLite. |
Docker¶
| Container | Description |
|---|---|
| docker-compose | No description |
| fleet | fleet provides an online web interface which displays a set of maintained images from one or more owned repositories. |
Documents¶
| Container | Description |
|---|---|
| libreoffice | LibreOffice is a free and powerful office suite, and a successor to OpenOffice.org (commonly known as OpenOffice). Its clean interface and feature-rich tools help you unleash your creativity and enhance your productivity. |
| paperless-ng | paperless-ng is an application by Daniel Quinn and contributors that indexes your scanned documents and allows you to easily search for documents and store metadata alongside your documents." |
| paperless-ngx | paperless-ngx is an application by Daniel Quinn and contributors that indexes your scanned documents and allows you to easily search for documents and store metadata alongside your documents." |
| papermerge | papermerge is an open source document management system (DMS) primarily designed for archiving and retrieving your digital documents. Instead of having piles of paper documents all over your desk, office or drawers - you can quickly scan them and configure your scanner to directly upload to Papermerge DMS." |
Downloaders¶
| Container | Description |
|---|---|
| deluge | deluge is a lightweight, Free Software, cross-platform BitTorrent client. |
| nntp2nntp | nntp2nntp proxy allow you to use your NNTP Account from multiple systems, each with own user name and password. It fully supports SSL and you can also limit the access to proxy with SSL certificates. nntp2nntp proxy is very simple and pretty fast. |
| nzbget | nzbget is a usenet downloader, written in C++ and designed with performance in mind to achieve maximum download speed by using very little system resources. |
| pyload-ng | pyLoad is a Free and Open Source download manager written in Python and designed to be extremely lightweight, easily extensible and fully manageable via web. |
| qbittorrent | The qbittorrent project aims to provide an open-source software alternative to µTorrent. qBittorrent is based on the Qt toolkit and libtorrent-rasterbar library. |
| sabnzbd | sabnzbd makes Usenet as simple and streamlined as possible by automating everything we can. All you have to do is add an .nzb. SABnzbd takes over from there, where it will be automatically downloaded, verified, repaired, extracted and filed away with zero human interaction. |
| transmission | transmission is designed for easy, powerful use. Transmission has the features you want from a BitTorrent client: encryption, a web interface, peer exchange, magnet links, DHT, µTP, UPnP and NAT-PMP port forwarding, webseed support, watch directories, tracker editing, global and per-torrent speed limits, and more. |
FTP¶
| Container | Description |
|---|---|
| davos | davos is an FTP automation tool that periodically scans given host locations for new files. It can be configured for various purposes, including listening for specific files to appear in the host location, ready for it to download and then move, if required. It also supports completion notifications as well as downstream API calls, to further the workflow. |
| filezilla | FIleZilla Client is a fast and reliable cross-platform FTP, FTPS and SFTP client with lots of useful features and an intuitive graphical user interface. |
Family¶
| Container | Description |
|---|---|
| babybuddy | babybuddy is a buddy for babies! Helps caregivers track sleep, feedings, diaper changes, tummy time and more to learn about and predict baby's needs without (as much) guess work. |
File Sharing¶
| Container | Description |
|---|---|
| projectsend | projectsend is a self-hosted application that lets you upload files and assign them to specific clients that you create yourself. Secure, private and easy. No more depending on external services or e-mail to send those files. |
| pwndrop | pwndrop is a self-deployable file hosting service for sending out red teaming payloads or securely sharing your private files over HTTP and WebDAV. |
| pydio-cells | pydio-cells is the nextgen file sharing platform for organizations. It is a full rewrite of the Pydio project using the Go language following a micro-service architecture. |
| snapdrop | snapdrop A local file sharing in your browser. Inspired by Apple's Airdrop. |
| xbackbone | xbackbone is a simple, self-hosted, lightweight PHP file manager that support the instant sharing tool ShareX and *NIX systems. It supports uploading and displaying images, GIF, video, code, formatted text, and file downloading and uploading. Also have a web UI with multi user management, past uploads history and search support. |
Finance¶
| Container | Description |
|---|---|
| budge | budge is an open source 'budgeting with envelopes' personal finance app. |
Games¶
| Container | Description |
|---|---|
| emulatorjs | emulatorjs - In browser web based emulation portable to nearly any device for many retro consoles. A mix of emulators is used between Libretro and EmulatorJS. |
| minetest | minetest (server) is a near-infinite-world block sandbox game and a game engine, inspired by InfiniMiner, Minecraft, and the like. |
Graphics¶
| Container | Description |
|---|---|
| blender | Blender is a free and open-source 3D computer graphics software toolset used for creating animated films, visual effects, art, 3D printed models, motion graphics, interactive 3D applications, virtual reality, and computer games. This image does not support GPU rendering out of the box only accelerated workspace experience |
| kdenlive | Kdenlive is a powerful free and open source cross-platform video editing program made by the KDE community. Feature rich and production ready. |
IRC¶
| Container | Description |
|---|---|
| limnoria | limnoria A robust, full-featured, and user/programmer-friendly Python IRC bot, with many existing plugins. Successor of the well-known Supybot. |
| ngircd | ngircd is a free, portable and lightweight Internet Relay Chat server for small or private networks, developed under the GNU General Public License (GPL). It is easy to configure, can cope with dynamic IP addresses, and supports IPv6, SSL-protected connections as well as PAM for authentication. It is written from scratch and not based on the original IRCd. |
| 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. |
| quassel-core | quassel-core is a modern, cross-platform, distributed IRC client, meaning that one (or multiple) client(s) can attach to and detach from a central core. |
| quassel-web | quassel-web is a web client for Quassel. Note that a Quassel-Core instance is required, we have a container available here. |
| thelounge | thelounge (a fork of shoutIRC) is a web IRC client that you host on your own server. |
| znc | znc is an IRC network bouncer or BNC. It can detach the client from the actual IRC server, and also from selected channels. Multiple clients from different locations can connect to a single ZNC account simultaneously and therefore appear under the same nickname on IRC. |
Indexers¶
| Container | Description |
|---|---|
| jackett | jackett works as a proxy server: it translates queries from apps (Sonarr, SickRage, CouchPotato, Mylar, etc) into tracker-site-specific http queries, parses the html response, then sends results back to the requesting software. This allows for getting recent uploads (like RSS) and performing searches. Jackett is a single repository of maintained indexer scraping & translation logic - removing the burden from other apps. |
| nzbhydra2 | nzbhydra2 is a meta search application for NZB indexers, the "spiritual successor" to NZBmegasearcH, and an evolution of the original application NZBHydra. |
| prowlarr | prowlarr is a indexer manager/proxy built on the popular arr .net/reactjs base stack to integrate with your various PVR apps. Prowlarr supports both Torrent Trackers and Usenet Indexers. It integrates seamlessly with Sonarr, Radarr, Lidarr, and Readarr offering complete management of your indexers with no per app Indexer setup required (we do it all). |
Media Management¶
| Container | Description |
|---|---|
| bazarr | bazarr is a companion application to Sonarr and Radarr. It can manage and download subtitles based on your requirements. You define your preferences by TV show or movie and Bazarr takes care of everything for you. |
| medusa | medusa is an automatic Video Library Manager for TV Shows. It watches for new episodes of your favorite shows, and when they are posted it does its magic. |
| plex-meta-manager | plex-meta-manager is a Python 3 script that can be continuously run using YAML configuration files to update on a schedule the metadata of the movies, shows, and collections in your libraries as well as automatically build collections based on various methods all detailed in the wiki. |
| radarr | radarr - A fork of Sonarr to work with movies à la Couchpotato. |
| sickchill | sickchill is an Automatic Video Library Manager for TV Shows. It watches for new episodes of your favorite shows, and when they are posted it does its magic. |
| sickgear | SickGear provides management of TV shows and/or Anime, it detects new episodes, links downloader apps, and more.. |
| sonarr | sonarr (formerly NZBdrone) is a PVR for usenet and bittorrent users. It can monitor multiple RSS feeds for new episodes of your favorite shows and will grab, sort and rename them. It can also be configured to automatically upgrade the quality of files already downloaded when a better quality format becomes available. |
Media Players¶
| Container | Description |
|---|---|
| emby | emby organizes video, music, live TV, and photos from personal media libraries and streams them to smart TVs, streaming boxes and mobile devices. This container is packaged as a standalone emby Media Server. |
| jellyfin | jellyfin is a Free Software Media System that puts you in control of managing and streaming your media. It is an alternative to the proprietary Emby and Plex, to provide media from a dedicated server to end-user devices via multiple apps. Jellyfin is descended from Emby's 3.5.2 release and ported to the .NET Core framework to enable full cross-platform support. There are no strings attached, no premium licenses or features, and no hidden agendas: just a team who want to build something better and work together to achieve it. |
| plex | plex organizes video, music and photos from personal media libraries and streams them to smart TVs, streaming boxes and mobile devices. This container is packaged as a standalone Plex Media Server. has always been a top priority. Straightforward design and bulk actions mean getting things done faster. |
Media Requesters¶
| Container | Description |
|---|---|
| doplarr | doplarr is an *arr request bot for Discord." |
| ombi | ombi allows you to host your own Plex Request and user management system. |
| overseerr | overseerr is a request management and media discovery tool built to work with your existing Plex ecosystem. |
Media Tools¶
| Container | Description |
|---|---|
| embystat | embystat is a personal web server that can calculate all kinds of statistics from your (local) Emby server. Just install this on your server and let him calculate all kinds of fun stuff. |
| ffmpeg | No description |
| htpcmanager | htpcmanager is a front end for many htpc related applications. |
| minisatip | minisatip is a multi-threaded satip server version 1.2 that runs under Linux and it was tested with DVB-S, DVB-S2, DVB-T, DVB-T2, DVB-C, DVB-C2, ATSC and ISDB-T cards. |
| oscam | oscam is an Open Source Conditional Access Module software used for descrambling DVB transmissions using smart cards. It's both a server and a client. |
| synclounge | synclounge is a third party tool that allows you to watch Plex in sync with your friends/family, wherever you are. |
| tautulli | tautulli is a python based web application for monitoring, analytics and notifications for Plex Media Server. |
| tvheadend | tvheadend works as a proxy server: is a TV streaming server and recorder for Linux, FreeBSD and Android supporting DVB-S, DVB-S2, DVB-C, DVB-T, ATSC, ISDB-T, IPTV, SAT>IP and HDHomeRun as input sources. |
| webgrabplus | webgrabplus is a multi-site incremental xmltv epg grabber. It collects tv-program guide data from selected tvguide sites for your favourite channels. |
Monitor¶
| Container | Description |
|---|---|
| apprise-api | apprise-api Takes advantage of Apprise through your network with a user-friendly API. |
| healthchecks | healthchecks is a watchdog for your cron jobs. It's a web server that listens for pings from your cron jobs, plus a web interface. |
| librespeed | librespeed is a very lightweight Speedtest implemented in Javascript, using XMLHttpRequest and Web Workers. |
| smokeping | smokeping keeps track of your network latency. For a full example of what this application is capable of visit UCDavis. |
| syslog-ng | syslog-ng allows you to flexibly collect, parse, classify, rewrite and correlate logs from across your infrastructure and store or route them to log analysis tools. |
Music¶
| Container | Description |
|---|---|
| airsonic-advanced | airsonic-advanced is a free, web-based media streamer, providing ubiquitious access to your music. Use it to share your music with friends, or to listen to your own music while at work. You can stream to multiple players simultaneously, for instance to one player in your kitchen and another in your living room. |
| audacity | Audacity is an easy-to-use, multi-track audio editor and recorder. Developed by a group of volunteers as open source. |
| beets | beets is a music library manager and not, for the most part, a music player. It does include a simple player plugin and an experimental Web-based player, but it generally leaves actual sound-reproduction to specialized tools. |
| daapd | daapd (iTunes) media server with support for AirPlay devices, Apple Remote (and compatibles), Chromecast, MPD and internet radio. |
| headphones | headphones is an automated music downloader for NZB and Torrent, written in Python. It supports SABnzbd, NZBget, Transmission, µTorrent and Blackhole. |
| lidarr | lidarr is a music collection manager for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new tracks from your favorite artists and will grab, sort and rename them. It can also be configured to automatically upgrade the quality of files already downloaded when a better quality format becomes available. |
| mstream | mstream is a personal music streaming server. You can use mStream to stream your music from your home computer to any device, anywhere. There are mobile apps available for both Android and iPhone. |
Network¶
| Container | Description |
|---|---|
| unifi-controller | The unifi-controller software is a powerful, enterprise wireless software engine ideal for high-density client deployments requiring low latency and high uptime performance. |
| wireshark | Wireshark is the world’s foremost and widely-used network protocol analyzer. It lets you see what’s happening on your network at a microscopic level and is the de facto (and often de jure) standard across many commercial and non-profit enterprises, government agencies, and educational institutions. Wireshark development thrives thanks to the volunteer contributions of networking experts around the globe and is the continuation of a project started by Gerald Combs in 1998. |
Photos¶
| Container | Description |
|---|---|
| chevereto | chevereto is an image hosting software that allows you to create a beautiful and full-featured image hosting website on your own server. It's your hosting and your rules, so say goodbye to closures and restrictions. |
| darktable | darktable is an open source photography workflow application and raw developer. A virtual lighttable and darkroom for photographers. It manages your digital negatives in a database, lets you view them through a zoomable lighttable and enables you to develop raw images and enhance them. |
| digikam | digiKam: Professional Photo Management with the Power of Open Source |
| lychee | lychee is a free photo-management tool, which runs on your server or web-space. Installing is a matter of seconds. Upload, manage and share photos like from a native application. Lychee comes with everything you need and all your photos are stored securely." |
| photoshow | photoshow is gallery software at its easiest, it doesn't even require a database. |
| piwigo | piwigo is a photo gallery software for the web that comes with powerful features to publish and manage your collection of pictures. |
| pixapop | pixapop is an open-source single page application to view your photos in the easiest way possible. |
Programming¶
| Container | Description |
|---|---|
| cloud9 | cloud9 Cloud9 is a complete web based IDE with terminal access. This container is for running their core SDK locally and developing plugins. |
| code-server | code-server is VS Code running on a remote server, accessible through the browser. |
| openvscode-server | openvscode-server provides a version of VS Code that runs a server on a remote machine and allows access through a modern web browser. |
| pylon | pylon is a web based integrated development environment built with Node.js as a backend and with a supercharged JavaScript/HTML5 frontend, licensed under GPL version 3. This project originates from Cloud9 v2 project. |
RSS¶
| Container | Description |
|---|---|
| freshrss | freshrss is a free, self-hostable aggregator for rss feeds. |
Recipes¶
| Container | Description |
|---|---|
| grocy | grocy is an ERP system for your kitchen! Cut down on food waste, and manage your chores with this brilliant utility. |
Remote¶
| Container | Description |
|---|---|
| guacd | guacd - Apache Guacamole is a clientless remote desktop gateway. It supports standard protocols like VNC, RDP, and SSH. This container is only the backend server component needed to use The official or 3rd party HTML5 frontends. |
| rdesktop | rdesktop - Containers containing full desktop environments in many popular flavors for Alpine, Ubuntu, Arch, and Fedora accessible via RDP. |
| remmina | Remmina is a remote desktop client written in GTK, aiming to be useful for system administrators and travellers, who need to work with lots of remote computers in front of either large or tiny screens. Remmina supports multiple network protocols, in an integrated and consistent user interface. Currently RDP, VNC, SPICE, NX, XDMCP, SSH and EXEC are supported. |
| webtop | webtop - Alpine, Ubuntu, Fedora, and Arch based containers containing full desktop environments in officially supported flavors accessible via any modern web browser. |
Science¶
| Container | Description |
|---|---|
| boinc | BOINC is a platform for high-throughput computing on a large scale (thousands or millions of computers). It can be used for volunteer computing (using consumer devices) or grid computing (using organizational resources). It supports virtualized, parallel, and GPU-based applications. |
| foldingathome | Folding@home is a distributed computing project for simulating protein dynamics, including the process of protein folding and the movements of proteins implicated in a variety of diseases. It brings together citizen scientists who volunteer to run simulations of protein dynamics on their personal computers. Insights from this data are helping scientists to better understand biology, and providing new opportunities for developing therapeutics. |
Storage¶
| Container | Description |
|---|---|
| diskover | diskover is an open source file system indexer that uses Elasticsearch to index and manage data across heterogeneous storage systems. |
| qdirstat | QDirStat Qt-based directory statistics: KDirStat without any KDE -- from the author of the original KDirStat. |
| scrutiny | scrutiny WebUI for smartd S.M.A.R.T monitoring. Scrutiny is a Hard Drive Health Dashboard & Monitoring solution, merging manufacturer provided S.M.A.R.T metrics with real-world failure rates from Backblaze. |
Tools¶
| Container | Description |
|---|---|
| yq | No description |
VPN¶
| Container | Description |
|---|---|
| wireguard | WireGuard® is an extremely simple yet fast and modern VPN that utilizes state-of-the-art cryptography. It aims to be faster, simpler, leaner, and more useful than IPsec, while avoiding the massive headache. It intends to be considerably more performant than OpenVPN. WireGuard is designed as a general purpose VPN for running on embedded interfaces and super computers alike, fit for many different circumstances. Initially released for the Linux kernel, it is now cross-platform (Windows, macOS, BSD, iOS, Android) and widely deployable. It is currently under heavy development, but already it might be regarded as the most secure, easiest to use, and simplest VPN solution in the industry. |
Web¶
| Container | Description |
|---|---|
| firefox | Firefox Browser, also known as Mozilla Firefox or simply Firefox, is a free and open-source web browser developed by the Mozilla Foundation and its subsidiary, the Mozilla Corporation. Firefox uses the Gecko layout engine to render web pages, which implements current and anticipated web standards. |
| grav | grav is a Fast, Simple, and Flexible, file-based Web-platform. |
| nginx | nginx is a simple webserver with php support. The config files reside in /config for easy user customization. |
| swag | SWAG - Secure Web Application Gateway (formerly known as letsencrypt, no relation to Let's Encrypt™) sets up an Nginx webserver and reverse proxy with php support and a built-in certbot client that automates free SSL server certificate generation and renewal processes (Let's Encrypt and ZeroSSL). It also contains fail2ban for intrusion prevention. |
Wiki¶
| Container | Description |
|---|---|
| bookstack | bookstack is a free and open source Wiki designed for creating beautiful documentation. Featuring a simple, but powerful WYSIWYG editor it allows for teams to create detailed and useful documentation with ease. |
| dillinger | dillinger is a cloud-enabled, mobile-ready, offline-storage, AngularJS powered HTML5 Markdown editor. |
| dokuwiki | dokuwiki is a simple to use and highly versatile Open Source wiki software that doesn't require a database. It is loved by users for its clean and readable syntax. The ease of maintenance, backup and integration makes it an administrator's favorite. Built in access controls and authentication connectors make DokuWiki especially useful in the enterprise context and the large number of plugins contributed by its vibrant community allow for a broad range of use cases beyond a traditional wiki. |
| hedgedoc | HedgeDoc gives you access to all your files wherever you are. |
| raneto | raneto - is an open source Knowledgebase platform that uses static Markdown files to power your Knowledgebase. |
| wikijs | wikijs A modern, lightweight and powerful wiki app built on NodeJS. |
Awesome LSIO¶
Administration¶
| Container | Description |
|---|---|
| doublecommander | Double Commander is a free cross platform open source file manager with two panels side by side. It is inspired by Total Commander and features some new ideas. |
| endlessh | endlessh is an SSH tarpit that very slowly sends an endless, random SSH banner. It keeps SSH clients locked up for hours or even days at a time. The purpose is to put your real SSH server on another port and then let the script kiddies get stuck in this tarpit instead of bothering a real server. |
| ldap-auth | ldap-auth software is for authenticating users who request protected resources from servers proxied by nginx. It includes a daemon (ldap-auth) that communicates with an authentication server, and a webserver daemon that generates an authentication cookie based on the user’s credentials. The daemons are written in Python for use with a Lightweight Directory Access Protocol (LDAP) authentication server (OpenLDAP or Microsoft Windows Active Directory 2003 and 2012). |
| netbootxyz | netbootxyz is a way to PXE boot various operating system installers or utilities from one place within the BIOS without the need of having to go retrieve the media to run the tool. iPXE is used to provide a user friendly menu from within the BIOS that lets you easily choose the operating system you want along with any specific types of versions or bootable flags. |
| netbox | netbox is an IP address management (IPAM) and data center infrastructure management (DCIM) tool. Initially conceived by the network engineering team at DigitalOcean, NetBox was developed specifically to address the needs of network and infrastructure engineers. It is intended to function as a domain-specific source of truth for network operations. |
| openssh-server | openssh-server is a sandboxed environment that allows ssh access without giving keys to the entire server. |
| snipe-it | snipe-it makes asset management easy. It was built by people solving real-world IT and asset management problems, and a solid UX has always been a top priority. Straightforward design and bulk actions mean getting things done faster. |
Audiobooks¶
| Container | Description |
|---|---|
| booksonic-air | booksonic-air is a platform for accessing the audiobooks you own wherever you are. At the moment the platform consists of |
Automation¶
| Container | Description |
|---|---|
| domoticz | domoticz is a Home Automation System that lets you monitor and configure various devices like: Lights, Switches, various sensors/meters like Temperature, Rain, Wind, UV, Electra, Gas, Water and much more. Notifications/Alerts can be sent to any mobile device. |
| habridge | habridge emulates Philips Hue API to other home automation gateways such as an Amazon Echo/Dot Gen 1 (gen 2 has issues discovering ha-bridge) or other systems that support Philips Hue. The Bridge handles basic commands such as "On", "Off" and "brightness" commands of the hue protocol. This bridge can control most devices that have a distinct API. |
| homeassistant | Home Assistant Core - Open source home automation that puts local control and privacy first. Powered by a worldwide community of tinkerers and DIY enthusiasts. Perfect to run on a Raspberry Pi or a local server. |
| kanzi | kanzi, formerly titled Kodi-Alexa, this custom skill is the ultimate voice remote control for navigating Kodi. It can do anything you can think of (100+ intents). This container also contains lexigram-cli to setup Kanzi with an Amazon Developer Account and automatically deploy it to Amazon. |
Backup¶
| Container | Description |
|---|---|
| duplicati | duplicati works with standard protocols like FTP, SSH, WebDAV as well as popular services like Microsoft OneDrive, Amazon Cloud Drive & S3, Google Drive, box.com, Mega, hubiC and many others. |
| resilio-sync | resilio-sync (formerly BitTorrent Sync) uses the BitTorrent protocol to sync files and folders between all of your devices. There are both free and paid versions, this container supports both. There is an official sync image but we created this one as it supports user mapping to simplify permissions for volumes. |
| rsnapshot | rsnapshot is a filesystem snapshot utility based on rsync. rsnapshot makes it easy to make periodic snapshots of local machines, and remote machines over ssh. The code makes extensive use of hard links whenever possible, to greatly reduce the disk space required." |
| syncthing | syncthing replaces proprietary sync and cloud services with something open, trustworthy and decentralized. Your data is your data alone and you deserve to choose where it is stored, if it is shared with some third party and how it's transmitted over the Internet. |
Books¶
| Container | Description |
|---|---|
| calibre | calibre is a powerful and easy to use e-book manager. Users say it’s outstanding and a must-have. It’ll allow you to do nearly everything and it takes things a step beyond normal e-book software. It’s also completely free and open source and great for both casual users and computer experts. |
| calibre-web | calibre-web is a web app providing a clean interface for browsing, reading and downloading eBooks using an existing Calibre database. It is also possible to integrate google drive and edit metadata and your calibre library through the app itself. |
| cops | cops by Sébastien Lucas, stands for Calibre OPDS (and HTML) Php Server. |
| lazylibrarian | lazylibrarian is a program to follow authors and grab metadata for all your digital reading needs. It uses a combination of Goodreads Librarything and optionally GoogleBooks as sources for author info and book info. This container is based on the DobyTang fork. |
| mylar3 | mylar3 is an automated Comic Book downloader (cbr/cbz) for use with NZB and torrents written in python. It supports SABnzbd, NZBGET, and many torrent clients in addition to DDL. |
| readarr | readarr - Book Manager and Automation (Sonarr for Ebooks) |
| ubooquity | ubooquity is a free, lightweight and easy-to-use home server for your comics and ebooks. Use it to access your files from anywhere, with a tablet, an e-reader, a phone or a computer. |
Cloud¶
| Container | Description |
|---|---|
| nextcloud | nextcloud gives you access to all your files wherever you are. |
Crypto¶
| Container | Description |
|---|---|
| gmail-order-bot | gmail-order-bot - A bot used to leverage a Gmail account as an order messaging service to consume email orders from Nano Checkout and process them using any custom logic you choose. |
| nano | nano is a digital payment protocol designed to be accessible and lightweight, with a focus on removing inefficiencies present in other cryptocurrencies. With ultrafast transactions and zero fees on a secure, green and decentralized network, this makes Nano ideal for everyday transactions. |
| nano-discord-bot | nano-discord-bot - A bot used to hook into a self hosted Nano RPC endpoint and discord server to Distribute funds from a faucet account. |
| nano-wallet | nano-wallet is a digital payment protocol designed to be accessible and lightweight, with a focus on removing inefficiencies present in other cryptocurrencies. With ultrafast transactions and zero fees on a secure, green and decentralized network, this makes Nano ideal for everyday transactions. |
DNS¶
| Container | Description |
|---|---|
| adguardhome-sync | adguardhome-sync is a tool to synchronize AdGuardHome config to replica instances. |
| ddclient | ddclient is a Perl client used to update dynamic DNS entries for accounts on Dynamic DNS Network Service Provider. It was originally written by Paul Burry and is now mostly by wimpunk. It has the capability to update more than just dyndns and it can fetch your WAN-ipaddress in a few different ways. |
| duckdns | duckdns is a free service which will point a DNS (sub domains of duckdns.org) to an IP of your choice. The service is completely free, and doesn't require reactivation or forum posts to maintain its existence. |
Dashboard¶
| Container | Description |
|---|---|
| heimdall | heimdall is a way to organise all those links to your most used web sites and web applications in a simple way. |
Databases¶
| Container | Description |
|---|---|
| mariadb | mariadb is one of the most popular database servers. Made by the original developers of MySQL. |
| mysql-workbench | MySQL Workbench is a unified visual tool for database architects, developers, and DBAs. MySQL Workbench provides data modeling, SQL development, and comprehensive administration tools for server configuration, user administration, backup, and much more. |
| phpmyadmin | phpmyadmin is a free software tool written in PHP, intended to handle the administration of MySQL over the Web. phpMyAdmin supports a wide range of operations on MySQL and MariaDB. |
| sqlitebrowser | DB Browser for SQLite is a high quality, visual, open source tool to create, design, and edit database files compatible with SQLite. |
Docker¶
| Container | Description |
|---|---|
| docker-compose | No description |
| fleet | fleet provides an online web interface which displays a set of maintained images from one or more owned repositories. |
Documents¶
| Container | Description |
|---|---|
| libreoffice | LibreOffice is a free and powerful office suite, and a successor to OpenOffice.org (commonly known as OpenOffice). Its clean interface and feature-rich tools help you unleash your creativity and enhance your productivity. |
| paperless-ng | paperless-ng is an application by Daniel Quinn and contributors that indexes your scanned documents and allows you to easily search for documents and store metadata alongside your documents." |
| paperless-ngx | paperless-ngx is an application by Daniel Quinn and contributors that indexes your scanned documents and allows you to easily search for documents and store metadata alongside your documents." |
| papermerge | papermerge is an open source document management system (DMS) primarily designed for archiving and retrieving your digital documents. Instead of having piles of paper documents all over your desk, office or drawers - you can quickly scan them and configure your scanner to directly upload to Papermerge DMS." |
Downloaders¶
| Container | Description |
|---|---|
| deluge | deluge is a lightweight, Free Software, cross-platform BitTorrent client. |
| nntp2nntp | nntp2nntp proxy allow you to use your NNTP Account from multiple systems, each with own user name and password. It fully supports SSL and you can also limit the access to proxy with SSL certificates. nntp2nntp proxy is very simple and pretty fast. |
| nzbget | nzbget is a usenet downloader, written in C++ and designed with performance in mind to achieve maximum download speed by using very little system resources. |
| pyload-ng | pyLoad is a Free and Open Source download manager written in Python and designed to be extremely lightweight, easily extensible and fully manageable via web. |
| qbittorrent | The qbittorrent project aims to provide an open-source software alternative to µTorrent. qBittorrent is based on the Qt toolkit and libtorrent-rasterbar library. |
| sabnzbd | sabnzbd makes Usenet as simple and streamlined as possible by automating everything we can. All you have to do is add an .nzb. SABnzbd takes over from there, where it will be automatically downloaded, verified, repaired, extracted and filed away with zero human interaction. |
| transmission | transmission is designed for easy, powerful use. Transmission has the features you want from a BitTorrent client: encryption, a web interface, peer exchange, magnet links, DHT, µTP, UPnP and NAT-PMP port forwarding, webseed support, watch directories, tracker editing, global and per-torrent speed limits, and more. |
FTP¶
| Container | Description |
|---|---|
| davos | davos is an FTP automation tool that periodically scans given host locations for new files. It can be configured for various purposes, including listening for specific files to appear in the host location, ready for it to download and then move, if required. It also supports completion notifications as well as downstream API calls, to further the workflow. |
| filezilla | FIleZilla Client is a fast and reliable cross-platform FTP, FTPS and SFTP client with lots of useful features and an intuitive graphical user interface. |
Family¶
| Container | Description |
|---|---|
| babybuddy | babybuddy is a buddy for babies! Helps caregivers track sleep, feedings, diaper changes, tummy time and more to learn about and predict baby's needs without (as much) guess work. |
File Sharing¶
| Container | Description |
|---|---|
| projectsend | projectsend is a self-hosted application that lets you upload files and assign them to specific clients that you create yourself. Secure, private and easy. No more depending on external services or e-mail to send those files. |
| pwndrop | pwndrop is a self-deployable file hosting service for sending out red teaming payloads or securely sharing your private files over HTTP and WebDAV. |
| pydio-cells | pydio-cells is the nextgen file sharing platform for organizations. It is a full rewrite of the Pydio project using the Go language following a micro-service architecture. |
| snapdrop | snapdrop A local file sharing in your browser. Inspired by Apple's Airdrop. |
| xbackbone | xbackbone is a simple, self-hosted, lightweight PHP file manager that support the instant sharing tool ShareX and *NIX systems. It supports uploading and displaying images, GIF, video, code, formatted text, and file downloading and uploading. Also have a web UI with multi user management, past uploads history and search support. |
Finance¶
| Container | Description |
|---|---|
| budge | budge is an open source 'budgeting with envelopes' personal finance app. |
Games¶
| Container | Description |
|---|---|
| emulatorjs | emulatorjs - In browser web based emulation portable to nearly any device for many retro consoles. A mix of emulators is used between Libretro and EmulatorJS. |
| minetest | minetest (server) is a near-infinite-world block sandbox game and a game engine, inspired by InfiniMiner, Minecraft, and the like. |
Graphics¶
| Container | Description |
|---|---|
| blender | Blender is a free and open-source 3D computer graphics software toolset used for creating animated films, visual effects, art, 3D printed models, motion graphics, interactive 3D applications, virtual reality, and computer games. This image does not support GPU rendering out of the box only accelerated workspace experience |
| kdenlive | Kdenlive is a powerful free and open source cross-platform video editing program made by the KDE community. Feature rich and production ready. |
IRC¶
| Container | Description |
|---|---|
| limnoria | limnoria A robust, full-featured, and user/programmer-friendly Python IRC bot, with many existing plugins. Successor of the well-known Supybot. |
| ngircd | ngircd is a free, portable and lightweight Internet Relay Chat server for small or private networks, developed under the GNU General Public License (GPL). It is easy to configure, can cope with dynamic IP addresses, and supports IPv6, SSL-protected connections as well as PAM for authentication. It is written from scratch and not based on the original IRCd. |
| 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. |
| quassel-core | quassel-core is a modern, cross-platform, distributed IRC client, meaning that one (or multiple) client(s) can attach to and detach from a central core. |
| quassel-web | quassel-web is a web client for Quassel. Note that a Quassel-Core instance is required, we have a container available here. |
| thelounge | thelounge (a fork of shoutIRC) is a web IRC client that you host on your own server. |
| znc | znc is an IRC network bouncer or BNC. It can detach the client from the actual IRC server, and also from selected channels. Multiple clients from different locations can connect to a single ZNC account simultaneously and therefore appear under the same nickname on IRC. |
Indexers¶
| Container | Description |
|---|---|
| jackett | jackett works as a proxy server: it translates queries from apps (Sonarr, SickRage, CouchPotato, Mylar, etc) into tracker-site-specific http queries, parses the html response, then sends results back to the requesting software. This allows for getting recent uploads (like RSS) and performing searches. Jackett is a single repository of maintained indexer scraping & translation logic - removing the burden from other apps. |
| nzbhydra2 | nzbhydra2 is a meta search application for NZB indexers, the "spiritual successor" to NZBmegasearcH, and an evolution of the original application NZBHydra. |
| prowlarr | prowlarr is a indexer manager/proxy built on the popular arr .net/reactjs base stack to integrate with your various PVR apps. Prowlarr supports both Torrent Trackers and Usenet Indexers. It integrates seamlessly with Sonarr, Radarr, Lidarr, and Readarr offering complete management of your indexers with no per app Indexer setup required (we do it all). |
Media Management¶
| Container | Description |
|---|---|
| bazarr | bazarr is a companion application to Sonarr and Radarr. It can manage and download subtitles based on your requirements. You define your preferences by TV show or movie and Bazarr takes care of everything for you. |
| medusa | medusa is an automatic Video Library Manager for TV Shows. It watches for new episodes of your favorite shows, and when they are posted it does its magic. |
| plex-meta-manager | plex-meta-manager is a Python 3 script that can be continuously run using YAML configuration files to update on a schedule the metadata of the movies, shows, and collections in your libraries as well as automatically build collections based on various methods all detailed in the wiki. |
| radarr | radarr - A fork of Sonarr to work with movies à la Couchpotato. |
| sickchill | sickchill is an Automatic Video Library Manager for TV Shows. It watches for new episodes of your favorite shows, and when they are posted it does its magic. |
| sickgear | SickGear provides management of TV shows and/or Anime, it detects new episodes, links downloader apps, and more.. |
| sonarr | sonarr (formerly NZBdrone) is a PVR for usenet and bittorrent users. It can monitor multiple RSS feeds for new episodes of your favorite shows and will grab, sort and rename them. It can also be configured to automatically upgrade the quality of files already downloaded when a better quality format becomes available. |
Media Players¶
| Container | Description |
|---|---|
| emby | emby organizes video, music, live TV, and photos from personal media libraries and streams them to smart TVs, streaming boxes and mobile devices. This container is packaged as a standalone emby Media Server. |
| jellyfin | jellyfin is a Free Software Media System that puts you in control of managing and streaming your media. It is an alternative to the proprietary Emby and Plex, to provide media from a dedicated server to end-user devices via multiple apps. Jellyfin is descended from Emby's 3.5.2 release and ported to the .NET Core framework to enable full cross-platform support. There are no strings attached, no premium licenses or features, and no hidden agendas: just a team who want to build something better and work together to achieve it. |
| plex | plex organizes video, music and photos from personal media libraries and streams them to smart TVs, streaming boxes and mobile devices. This container is packaged as a standalone Plex Media Server. has always been a top priority. Straightforward design and bulk actions mean getting things done faster. |
Media Requesters¶
| Container | Description |
|---|---|
| doplarr | doplarr is an *arr request bot for Discord." |
| ombi | ombi allows you to host your own Plex Request and user management system. |
| overseerr | overseerr is a request management and media discovery tool built to work with your existing Plex ecosystem. |
Media Tools¶
| Container | Description |
|---|---|
| embystat | embystat is a personal web server that can calculate all kinds of statistics from your (local) Emby server. Just install this on your server and let him calculate all kinds of fun stuff. |
| ffmpeg | No description |
| htpcmanager | htpcmanager is a front end for many htpc related applications. |
| minisatip | minisatip is a multi-threaded satip server version 1.2 that runs under Linux and it was tested with DVB-S, DVB-S2, DVB-T, DVB-T2, DVB-C, DVB-C2, ATSC and ISDB-T cards. |
| oscam | oscam is an Open Source Conditional Access Module software used for descrambling DVB transmissions using smart cards. It's both a server and a client. |
| synclounge | synclounge is a third party tool that allows you to watch Plex in sync with your friends/family, wherever you are. |
| tautulli | tautulli is a python based web application for monitoring, analytics and notifications for Plex Media Server. |
| tvheadend | tvheadend works as a proxy server: is a TV streaming server and recorder for Linux, FreeBSD and Android supporting DVB-S, DVB-S2, DVB-C, DVB-T, ATSC, ISDB-T, IPTV, SAT>IP and HDHomeRun as input sources. |
| webgrabplus | webgrabplus is a multi-site incremental xmltv epg grabber. It collects tv-program guide data from selected tvguide sites for your favourite channels. |
Monitor¶
| Container | Description |
|---|---|
| apprise-api | apprise-api Takes advantage of Apprise through your network with a user-friendly API. |
| healthchecks | healthchecks is a watchdog for your cron jobs. It's a web server that listens for pings from your cron jobs, plus a web interface. |
| librespeed | librespeed is a very lightweight Speedtest implemented in Javascript, using XMLHttpRequest and Web Workers. |
| smokeping | smokeping keeps track of your network latency. For a full example of what this application is capable of visit UCDavis. |
| syslog-ng | syslog-ng allows you to flexibly collect, parse, classify, rewrite and correlate logs from across your infrastructure and store or route them to log analysis tools. |
Music¶
| Container | Description |
|---|---|
| airsonic-advanced | airsonic-advanced is a free, web-based media streamer, providing ubiquitious access to your music. Use it to share your music with friends, or to listen to your own music while at work. You can stream to multiple players simultaneously, for instance to one player in your kitchen and another in your living room. |
| audacity | Audacity is an easy-to-use, multi-track audio editor and recorder. Developed by a group of volunteers as open source. |
| beets | beets is a music library manager and not, for the most part, a music player. It does include a simple player plugin and an experimental Web-based player, but it generally leaves actual sound-reproduction to specialized tools. |
| daapd | daapd (iTunes) media server with support for AirPlay devices, Apple Remote (and compatibles), Chromecast, MPD and internet radio. |
| headphones | headphones is an automated music downloader for NZB and Torrent, written in Python. It supports SABnzbd, NZBget, Transmission, µTorrent and Blackhole. |
| lidarr | lidarr is a music collection manager for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new tracks from your favorite artists and will grab, sort and rename them. It can also be configured to automatically upgrade the quality of files already downloaded when a better quality format becomes available. |
| mstream | mstream is a personal music streaming server. You can use mStream to stream your music from your home computer to any device, anywhere. There are mobile apps available for both Android and iPhone. |
Network¶
| Container | Description |
|---|---|
| unifi-controller | The unifi-controller software is a powerful, enterprise wireless software engine ideal for high-density client deployments requiring low latency and high uptime performance. |
| wireshark | Wireshark is the world’s foremost and widely-used network protocol analyzer. It lets you see what’s happening on your network at a microscopic level and is the de facto (and often de jure) standard across many commercial and non-profit enterprises, government agencies, and educational institutions. Wireshark development thrives thanks to the volunteer contributions of networking experts around the globe and is the continuation of a project started by Gerald Combs in 1998. |
Photos¶
| Container | Description |
|---|---|
| chevereto | chevereto is an image hosting software that allows you to create a beautiful and full-featured image hosting website on your own server. It's your hosting and your rules, so say goodbye to closures and restrictions. |
| darktable | darktable is an open source photography workflow application and raw developer. A virtual lighttable and darkroom for photographers. It manages your digital negatives in a database, lets you view them through a zoomable lighttable and enables you to develop raw images and enhance them. |
| digikam | digiKam: Professional Photo Management with the Power of Open Source |
| lychee | lychee is a free photo-management tool, which runs on your server or web-space. Installing is a matter of seconds. Upload, manage and share photos like from a native application. Lychee comes with everything you need and all your photos are stored securely." |
| photoshow | photoshow is gallery software at its easiest, it doesn't even require a database. |
| piwigo | piwigo is a photo gallery software for the web that comes with powerful features to publish and manage your collection of pictures. |
| pixapop | pixapop is an open-source single page application to view your photos in the easiest way possible. |
Programming¶
| Container | Description |
|---|---|
| cloud9 | cloud9 Cloud9 is a complete web based IDE with terminal access. This container is for running their core SDK locally and developing plugins. |
| code-server | code-server is VS Code running on a remote server, accessible through the browser. |
| openvscode-server | openvscode-server provides a version of VS Code that runs a server on a remote machine and allows access through a modern web browser. |
| pylon | pylon is a web based integrated development environment built with Node.js as a backend and with a supercharged JavaScript/HTML5 frontend, licensed under GPL version 3. This project originates from Cloud9 v2 project. |
RSS¶
| Container | Description |
|---|---|
| freshrss | freshrss is a free, self-hostable aggregator for rss feeds. |
Recipes¶
| Container | Description |
|---|---|
| grocy | grocy is an ERP system for your kitchen! Cut down on food waste, and manage your chores with this brilliant utility. |
Remote¶
| Container | Description |
|---|---|
| guacd | guacd - Apache Guacamole is a clientless remote desktop gateway. It supports standard protocols like VNC, RDP, and SSH. This container is only the backend server component needed to use The official or 3rd party HTML5 frontends. |
| rdesktop | rdesktop - Containers containing full desktop environments in many popular flavors for Alpine, Ubuntu, Arch, and Fedora accessible via RDP. |
| remmina | Remmina is a remote desktop client written in GTK, aiming to be useful for system administrators and travellers, who need to work with lots of remote computers in front of either large or tiny screens. Remmina supports multiple network protocols, in an integrated and consistent user interface. Currently RDP, VNC, SPICE, NX, XDMCP, SSH and EXEC are supported. |
| webtop | webtop - Alpine, Ubuntu, Fedora, and Arch based containers containing full desktop environments in officially supported flavors accessible via any modern web browser. |
Science¶
| Container | Description |
|---|---|
| boinc | BOINC is a platform for high-throughput computing on a large scale (thousands or millions of computers). It can be used for volunteer computing (using consumer devices) or grid computing (using organizational resources). It supports virtualized, parallel, and GPU-based applications. |
| foldingathome | Folding@home is a distributed computing project for simulating protein dynamics, including the process of protein folding and the movements of proteins implicated in a variety of diseases. It brings together citizen scientists who volunteer to run simulations of protein dynamics on their personal computers. Insights from this data are helping scientists to better understand biology, and providing new opportunities for developing therapeutics. |
Storage¶
| Container | Description |
|---|---|
| diskover | diskover is an open source file system indexer that uses Elasticsearch to index and manage data across heterogeneous storage systems. |
| qdirstat | QDirStat Qt-based directory statistics: KDirStat without any KDE -- from the author of the original KDirStat. |
| scrutiny | scrutiny WebUI for smartd S.M.A.R.T monitoring. Scrutiny is a Hard Drive Health Dashboard & Monitoring solution, merging manufacturer provided S.M.A.R.T metrics with real-world failure rates from Backblaze. |
Tools¶
| Container | Description |
|---|---|
| yq | No description |
VPN¶
| Container | Description |
|---|---|
| wireguard | WireGuard® is an extremely simple yet fast and modern VPN that utilizes state-of-the-art cryptography. It aims to be faster, simpler, leaner, and more useful than IPsec, while avoiding the massive headache. It intends to be considerably more performant than OpenVPN. WireGuard is designed as a general purpose VPN for running on embedded interfaces and super computers alike, fit for many different circumstances. Initially released for the Linux kernel, it is now cross-platform (Windows, macOS, BSD, iOS, Android) and widely deployable. It is currently under heavy development, but already it might be regarded as the most secure, easiest to use, and simplest VPN solution in the industry. |
Web¶
| Container | Description |
|---|---|
| firefox | Firefox Browser, also known as Mozilla Firefox or simply Firefox, is a free and open-source web browser developed by the Mozilla Foundation and its subsidiary, the Mozilla Corporation. Firefox uses the Gecko layout engine to render web pages, which implements current and anticipated web standards. |
| grav | grav is a Fast, Simple, and Flexible, file-based Web-platform. |
| nginx | nginx is a simple webserver with php support. The config files reside in /config for easy user customization. |
| swag | SWAG - Secure Web Application Gateway (formerly known as letsencrypt, no relation to Let's Encrypt™) sets up an Nginx webserver and reverse proxy with php support and a built-in certbot client that automates free SSL server certificate generation and renewal processes (Let's Encrypt and ZeroSSL). It also contains fail2ban for intrusion prevention. |
Wiki¶
| Container | Description |
|---|---|
| bookstack | bookstack is a free and open source Wiki designed for creating beautiful documentation. Featuring a simple, but powerful WYSIWYG editor it allows for teams to create detailed and useful documentation with ease. |
| dillinger | dillinger is a cloud-enabled, mobile-ready, offline-storage, AngularJS powered HTML5 Markdown editor. |
| dokuwiki | dokuwiki is a simple to use and highly versatile Open Source wiki software that doesn't require a database. It is loved by users for its clean and readable syntax. The ease of maintenance, backup and integration makes it an administrator's favorite. Built in access controls and authentication connectors make DokuWiki especially useful in the enterprise context and the large number of plugins contributed by its vibrant community allow for a broad range of use cases beyond a traditional wiki. |
| hedgedoc | HedgeDoc gives you access to all your files wherever you are. |
| raneto | raneto - is an open source Knowledgebase platform that uses static Markdown files to power your Knowledgebase. |
| wikijs | wikijs A modern, lightweight and powerful wiki app built on NodeJS. |
Customizing LinuxServer Containers¶
One of the challenges we face as an organization is making everyone happy with the functionality we provide for the software we package in Docker containers. As the projects that we package and distribute grow, conventionally so do the use cases along with large communities of power users. As it has become very difficult for us to support Swiss Army Knife style images we are looking to the community of users to start customizing our base image layer themselves.
Something we provide and pride ourselves on is keeping our containers up to date with not only the latest external software releases, but also with the latest distribution level packages. Conventionally when people needed some form of custom functionality they would fork our source and build something once that suited their needs leaving this dangling fork without updates or basic maintenance.
Behind the scenes we have been working to provide the community with the ability to customize our images not only for themselves but also for other users. This comes in the form of 3 different tools:
- Private Custom Scripts: Run once when the container is started before services (including the main service/app) are started
- Private Custom Services: Run at the same time as other services. Service get restarted on exit
- Public Facing Docker Mods: Provide extensions to the containers filesystem. Scripts/services can be implemented as s6 services
All of the functionality described in this post is live on every one of the containers we currently maintain:
NOTE: While the following support has been added to our containers, we will not give support to any custom scripts, services, or mods. If you are having an issue with one of our containers, be sure to disable all custom scripts/services/mods before seeking support.
Custom Scripts¶
The first part of this update is the support for a user's custom scripts to run at startup. In every container, simply create a new folder located at /custom-cont-init.d and add any scripts you want. These scripts can contain logic for installing packages, copying over custom files to other locations, or installing plugins.
Because this location is outside of /config you will need to mount it like any other volume if you wish to make use of it. e.g. -v /home/foo/appdata/my-custom-files:/custom-cont-init.d if using the Docker CLI or
services:
+ Customizing LinuxServer Containers - LinuxServer.io Customizing LinuxServer Containers¶
One of the challenges we face as an organization is making everyone happy with the functionality we provide for the software we package in Docker containers. As the projects that we package and distribute grow, conventionally so do the use cases along with large communities of power users. As it has become very difficult for us to support Swiss Army Knife style images we are looking to the community of users to start customizing our base image layer themselves.
Something we provide and pride ourselves on is keeping our containers up to date with not only the latest external software releases, but also with the latest distribution level packages. Conventionally when people needed some form of custom functionality they would fork our source and build something once that suited their needs leaving this dangling fork without updates or basic maintenance.
Behind the scenes we have been working to provide the community with the ability to customize our images not only for themselves but also for other users. This comes in the form of 3 different tools:
- Private Custom Scripts: Run once when the container is started before services (including the main service/app) are started
- Private Custom Services: Run at the same time as other services. Service get restarted on exit
- Public Facing Docker Mods: Provide extensions to the containers filesystem. Scripts/services can be implemented as s6 services
All of the functionality described in this post is live on every one of the containers we currently maintain:
NOTE: While the following support has been added to our containers, we will not give support to any custom scripts, services, or mods. If you are having an issue with one of our containers, be sure to disable all custom scripts/services/mods before seeking support.
Custom Scripts¶
The first part of this update is the support for a user's custom scripts to run at startup. In every container, simply create a new folder located at /custom-cont-init.d and add any scripts you want. These scripts can contain logic for installing packages, copying over custom files to other locations, or installing plugins.
Because this location is outside of /config you will need to mount it like any other volume if you wish to make use of it. e.g. -v /home/foo/appdata/my-custom-files:/custom-cont-init.d if using the Docker CLI or
services:
bar:
volumes:
- /home/foo/appdata/bar:/config
@@ -33,4 +33,4 @@
-v path to watch folder:/watch \
--restart unless-stopped \
linuxserver/transmission
-
The source code for this mod can be found here.
NOTE: When pulling in logic from external sources practice caution and trust the sources/community you get them from, as there are extreme security implications to consuming files from sources outside of our control.
We are here to help¶
If you are interested in writing custom logic and possibly sharing it with the community in the form of a Docker Mod we are always available to help you out.
Our Discord server is best for quick direct contact and our Forum for a longer running project.
There is zero barrier to entry for these levels of container customization and you are in complete control.
We are looking forward to your next creation.
\ No newline at end of file
+The source code for this mod can be found here.
NOTE: When pulling in logic from external sources practice caution and trust the sources/community you get them from, as there are extreme security implications to consuming files from sources outside of our control.
We are here to help¶
If you are interested in writing custom logic and possibly sharing it with the community in the form of a Docker Mod we are always available to help you out.
Our Discord server is best for quick direct contact and our Forum for a longer running project.
There is zero barrier to entry for these levels of container customization and you are in complete control.
We are looking forward to your next creation.
Container Execution¶
You may find at some point you need to view the internal data of a container.
Shell Access¶
Particularly useful when debugging the application - to shell in to one of our containers, run the following:
docker exec -it <container_name> /bin/bash
+ Container Execution - LinuxServer.io Container Execution¶
You may find at some point you need to view the internal data of a container.
Shell Access¶
Particularly useful when debugging the application - to shell in to one of our containers, run the following:
Tailing the logs¶
The vast majority of our images are configured to output the application logs to the console, which in Docker's terms means you can access them using the docker logs command:
The --tail argument is optional, but useful if the application has been running for a long time - the logs command by default will output all logs.
To make life simpler for yourself here's a handy bash alias to do some of the leg work for you:
Execute it with dtail <container_name>.
Checking the build version¶
If you are experiencing issues with one of our containers, it helps us to know which version of the image your container is running from. The primary reason we ask for this is because you may be reporting an issue we are aware of and have subsequently fixed. However, if you are running on the latest version of our image, it could indeed be a newly found bug, which we'd want to know more about.
To obtain the build version for the container:
Or the image:
\ No newline at end of file
+Docker Containers: 101¶
A container bundles all the libraries required by an application to run, you no longer need to know which version of Java, Apache or whatever – the person who built the container for you took care of that. Containers don’t usually ship with configuration files baked in though. This is because the contents of a container are ‘stateless’ or ‘immutable’. In English, this means the state or filesystem of the container itself cannot be modified after it is created.
What do I need to know?¶
To get started, not much. You will need to know about some of the terminology or concepts when performing more advanced tasks or troubleshooting but getting started couldn't be much simpler.
docker run hello-world
+ Docker Containers: 101 - LinuxServer.io Docker Containers: 101¶
A container bundles all the libraries required by an application to run, you no longer need to know which version of Java, Apache or whatever – the person who built the container for you took care of that. Containers don’t usually ship with configuration files baked in though. This is because the contents of a container are ‘stateless’ or ‘immutable’. In English, this means the state or filesystem of the container itself cannot be modified after it is created.
What do I need to know?¶
To get started, not much. You will need to know about some of the terminology or concepts when performing more advanced tasks or troubleshooting but getting started couldn't be much simpler.
That's it, your first docker container. It pre-supposes you have docker installed but that's all it takes to run a container. You didn't need to know anything about installed what that app needed to run - this is the key benefit. hello-world is a simple example but imagine you have a complex application with a large number of dependencies and it is tied to a specific version of Python or Java. Then imagine you have a second app again tied to a specific, but different, version of Java or Python. Now you have to try and ensure these two (often conflicting) versions sit on the same host and play nice. In the world of containers these two versions can operate in complete isolation from one another. Bliss.
Key Terminology¶
There are a few terms you might find useful to understand when working with containers:
- docker - the first, and most popular, container runtime - it sits as an abstraction layer between the kernels features such as cgroups or namespaces and running applications
- container - a sandboxed process isolated in memory and running instance of an image
- image - a pre-built filesystem in a format ready to be understood by a container runtime (usually docker)
- volume - use volumes to persist data outside of the containers sandboxed filesystem
- environment - a way of configuring the sandboxed environment your container runs in
Key Concepts¶
Containers are completely sandboxed environments by the Linux kernel. It may help you to think of them somewhat like a small VM however in practice this is largely false. The Linux kernel controls access to various system resources utilising control groups (cgroups). We rely on docker to translate these complex concepts into simple ones that users can understand and consume.
By default a running container has absolutely no context of the world around it. Out the box you cannot connect from the outside world to the running webservers on ports 80 and 443 below. To allow entry to the sandbox from the outside world we must explicitly allow entry using the -p flag.
Take this concept and multiply it across all aspects of a running application. Ports, volumes (i.e. the files you want to be available inside the container from outside the container), environment variables and so on. For us as developers this allows us to isolate your system from troubleshooting as the box the container is running in (the container) is identical to the next.
Containers are an amazing way to run applications in a secure, sandboxed way.
\ No newline at end of file
+Take this concept and multiply it across all aspects of a running application. Ports, volumes (i.e. the files you want to be available inside the container from outside the container), environment variables and so on. For us as developers this allows us to isolate your system from troubleshooting as the box the container is running in (the container) is identical to the next.
Containers are an amazing way to run applications in a secure, sandboxed way.
Docker Compose¶
Intro¶
Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.
Note that when inputting data for variables, you must follow standard YAML rules. In the case of passwords with special characters this can mean escaping them properly ($ is the escape character) or properly quoting the variable. The best course of action if you do not know how to do this or are unwilling to research, is to stick to alphanumeric characters only.
Installation¶
- Install Option 1 (recommended)
Starting with version 2, Docker started publishing docker compose as a go based plugin for docker (rather than a python based standalone binary). And they also publish this plugin for various arches, including x86_64, armhf and aarch64 (as opposed to the x86_64 only binaries for v1.X). Therefore we updated our recommended install option to utilize the plugin.
Install docker from the official repos as described here or via the convenient get-docker script as described below:
curl -fsSL https://get.docker.com -o get-docker.sh && \
+ Docker Compose - LinuxServer.io Docker Compose¶
Intro¶
Compose is a tool for defining and running multi-container Docker applications. With Compose, you use a YAML file to configure your application’s services. Then, with a single command, you create and start all the services from your configuration.
Note that when inputting data for variables, you must follow standard YAML rules. In the case of passwords with special characters this can mean escaping them properly ($ is the escape character) or properly quoting the variable. The best course of action if you do not know how to do this or are unwilling to research, is to stick to alphanumeric characters only.
Installation¶
- Install Option 1 (recommended)
Starting with version 2, Docker started publishing docker compose as a go based plugin for docker (rather than a python based standalone binary). And they also publish this plugin for various arches, including x86_64, armhf and aarch64 (as opposed to the x86_64 only binaries for v1.X). Therefore we updated our recommended install option to utilize the plugin.
Install docker from the official repos as described here or via the convenient get-docker script as described below:
- Install Option 2 (manual)
You can install docker compose manually via the following commands:
ARCH=$(uname -m) && [[ "${ARCH}" == "armv7l" ]] && ARCH="armv7" && \
sudo mkdir -p /usr/local/lib/docker/cli-plugins && \
@@ -83,4 +83,4 @@
There are multiple ways to see the logs of your containers. In some instances, using docker logs is preferable to docker compose logs. By default docker logs will not run unless you define which service the logs are coming from. The docker compose logs will pull all of the logs for the services defined in the docker-compose.yml file.
When asking for help, you should post your logs or be ready to provide logs if someone requests it. If you are running multiple containers in your docker-compose.yml file, it is not helpful to submit all of the logs. If you are experiencing issues with a single service, say Heimdall, then you would want to get your logs using docker logs heimdall or docker compose logs heimdall. The bash_alias for dclogs can be used if you define your service after you've typed the alias. Likewise, the bash_alias detail will not run without defining the service after it.
Some distributions, like Ubuntu, already have the code snippet below in the ~/.bashrc file. If it is not included, you'll need to add the following to your ~/.bashrc file in order for the aliases file to be picked up:
Once configured, you can run source ~/.bashrc or log out and the log in again. Now you can type dcpull or dcup to manage your entire fleet of containers at once. It's like magic.
\ No newline at end of file
+Once configured, you can run source ~/.bashrc or log out and the log in again. Now you can type dcpull or dcup to manage your entire fleet of containers at once. It's like magic.
Fleet¶
How Fleet works¶
Fleet stores a snapshot of Docker Images in its own database, consisting of metadata deemed most pertinent to both the users of the images, and the repository owner. It will synchronize with Docker Hub over a set interval in order to update its stored data.
It then displays this snapshot data on its own status page as a useful list, containing links to each repository and image owned by the repository owner. Each image also contains a status which is managed by the repository owner, who can define images as either Stable or Unstable. This is designed to quickly help users know when an image is undergoing a state of instability which is known by the owner.
Why a snapshot?¶
In short, Docker Hub's API is very slow. It would not be a good long-term solution to just proxy the responses from Docker Hub and translate the data into something considered useful by downstream clients. By caching the image information in its own database, Fleet is able to more efficiently return the status data for each image and repository. In doing so, it is also able to provide more concise data, such as image versions, as part of the primary response, rather than requiring users to make a separate call.
As an example comparison between obtaining all image name, pull and version information for all LinuxServer images from Docker Hub, and then obtaining that same data via Fleet's API:
| API | Time (ms) |
|---|---|
| Docker Hub (multiple calls) | 52000ms |
| Fleet | 50ms |
Capabilities¶
Fleet has the ability to display images with a particular state, which provides contextual information to visitors of the application's main page.
Hidden¶
If an image is hidden, it will not be displayed as part of the main list, nor will it be returned as part of any API calls. This also means that the pull count of a hidden image is not included.
Unstable¶
Marks an image as having issues known by the maintainer. A useful state to assign to an image if the latest build (or builds) are causing downstream breakages. This may also be useful if an upstream dependency or application is causing breakages in the image directly.
Deprecated¶
If the maintainer of the image, or upstream application no longer wishes to provide support, or if the image has reached its end-of-life (or has been superseded by another), marking an image as deprecated will ensure users are made aware that no further updates will be supplied, and should stop using it. Deprecation notices are also provided to give context.
API¶
Fleet exposes a single API endpoint which can be used to obtain image list and pull count information for all relevant images maintained by the repository
{% api-method method="get" host="https://fleet.linuxserver.io" path="/api/v1/images" %} {% api-method-summary %} Get All Repositories and Images
{% api-method-description %} Returns all synchronized images.
{% api-method-spec %}
{% api-method-response %} {% api-method-response-example httpCode=200 %} {% api-method-response-example-description %} All synchronized repositories and images returned.
{
+ Fleet - LinuxServer.io Fleet¶
How Fleet works¶
Fleet stores a snapshot of Docker Images in its own database, consisting of metadata deemed most pertinent to both the users of the images, and the repository owner. It will synchronize with Docker Hub over a set interval in order to update its stored data.
It then displays this snapshot data on its own status page as a useful list, containing links to each repository and image owned by the repository owner. Each image also contains a status which is managed by the repository owner, who can define images as either Stable or Unstable. This is designed to quickly help users know when an image is undergoing a state of instability which is known by the owner.
Why a snapshot?¶
In short, Docker Hub's API is very slow. It would not be a good long-term solution to just proxy the responses from Docker Hub and translate the data into something considered useful by downstream clients. By caching the image information in its own database, Fleet is able to more efficiently return the status data for each image and repository. In doing so, it is also able to provide more concise data, such as image versions, as part of the primary response, rather than requiring users to make a separate call.
As an example comparison between obtaining all image name, pull and version information for all LinuxServer images from Docker Hub, and then obtaining that same data via Fleet's API:
API Time (ms) Docker Hub (multiple calls) 52000ms Fleet 50ms
Capabilities¶
Fleet has the ability to display images with a particular state, which provides contextual information to visitors of the application's main page.
Hidden¶
If an image is hidden, it will not be displayed as part of the main list, nor will it be returned as part of any API calls. This also means that the pull count of a hidden image is not included.
Unstable¶
Marks an image as having issues known by the maintainer. A useful state to assign to an image if the latest build (or builds) are causing downstream breakages. This may also be useful if an upstream dependency or application is causing breakages in the image directly.
Deprecated¶
If the maintainer of the image, or upstream application no longer wishes to provide support, or if the image has reached its end-of-life (or has been superseded by another), marking an image as deprecated will ensure users are made aware that no further updates will be supplied, and should stop using it. Deprecation notices are also provided to give context.
API¶
Fleet exposes a single API endpoint which can be used to obtain image list and pull count information for all relevant images maintained by the repository
{% api-method method="get" host="https://fleet.linuxserver.io" path="/api/v1/images" %} {% api-method-summary %} Get All Repositories and Images
{% api-method-description %} Returns all synchronized images.
{% api-method-spec %}
{% api-method-response %} {% api-method-response-example httpCode=200 %} {% api-method-response-example-description %} All synchronized repositories and images returned.
{
"status": "OK",
"data" {
"totalPullCount": 1862494227,
@@ -51,4 +51,4 @@
# Password security
fleet.admin.secret=<a_random_string>
-
All configuration can be loaded either via the config file, via JVM arguments, or via the system environment. Fleet will first look in the configuration file, then JVM runtime, and finally in the system environment. It will load the first value it finds, which can be useful when needing to override specific properties.
{% hint style="info" %} If you place a property in the system environment, ensure that the property uses underscores rather than periods. This is due to a limitation in BASH environments where exported variables must not contain this character. E.g. fleet.app.port=8080 becomes export fleet_app_port=8080
Property Name Purpose fleet.app.portThe port which the application will be running under. fleet.admin.secretA string used as part of the password key derivation process. This secret is prepended to the raw password before its key is derived, providing further pseudo-randomness to hashed passwords. Once set, this must not be changed! It is vital to remain the same, as it will be used during the password verification step. If Fleet is restarted with this removed or set differently, the password verification process will fail because previously hashed passwords will have been derived with the old secret. fleet.database.driverThe driver to use for connections to Fleet's database. This should be org.mariadb.jdbc.Driver fleet.database.urlThe full JDBC connection string to the database. fleet.database.usernameThe username of the SQL user which will be managing the data in the Fleet database. This should have full GRANT access to the fleet database as it also manages any database migrations. fleet.database.passwordThe password for the SQL user
Runtime Arguments¶
As well as the base configuration file, Fleet also supports some runtime arguments by means of the -D flag. These can be used to direct Fleet to behave in a specific way at runtime.
{% hint style="info" %} Unlike the properties defined above, these properties are only accessed via the JVM arguments (-D).
Runtime Argument Purpose fleet.config.baseThe absolute path of the configuration file. fleet.show.passwordsTells fleet to show passwords in plain text in its logs. Not recommended. fleet.nuke.databaseBe very careful. This will tell Fleet to completely wipe and rebuild its database. This can be useful if the owner deems the database to be too far out of synchronisation with Docker Hub, or if images have since been removed but are still showing in Fleet. fleet.skip.sync.on.startupBy default, Fleet will run a synchronisation process when it first starts up. Setting this flag will tell it to skip the first run. The next synchronisation will be at the set interval.
Default User¶
When starting Fleet for the first time it will create a default user in order for you to log in and manage the repositories/images synchronised by the application. The default username and password are:
Username: admin
Password: admin
{% hint style="warning" %} You should change the default password for this user as soon as possible! This can be done via the Admin -> Users menu options.
\ No newline at end of file
+All configuration can be loaded either via the config file, via JVM arguments, or via the system environment. Fleet will first look in the configuration file, then JVM runtime, and finally in the system environment. It will load the first value it finds, which can be useful when needing to override specific properties.
{% hint style="info" %} If you place a property in the system environment, ensure that the property uses underscores rather than periods. This is due to a limitation in BASH environments where exported variables must not contain this character. E.g. fleet.app.port=8080 becomes export fleet_app_port=8080
| Property Name | Purpose |
|---|---|
fleet.app.port | The port which the application will be running under. |
fleet.admin.secret | A string used as part of the password key derivation process. This secret is prepended to the raw password before its key is derived, providing further pseudo-randomness to hashed passwords. Once set, this must not be changed! It is vital to remain the same, as it will be used during the password verification step. If Fleet is restarted with this removed or set differently, the password verification process will fail because previously hashed passwords will have been derived with the old secret. |
fleet.database.driver | The driver to use for connections to Fleet's database. This should be org.mariadb.jdbc.Driver |
fleet.database.url | The full JDBC connection string to the database. |
fleet.database.username | The username of the SQL user which will be managing the data in the Fleet database. This should have full GRANT access to the fleet database as it also manages any database migrations. |
fleet.database.password | The password for the SQL user |
Runtime Arguments¶
As well as the base configuration file, Fleet also supports some runtime arguments by means of the -D flag. These can be used to direct Fleet to behave in a specific way at runtime.
{% hint style="info" %} Unlike the properties defined above, these properties are only accessed via the JVM arguments (-D).
| Runtime Argument | Purpose |
|---|---|
fleet.config.base | The absolute path of the configuration file. |
fleet.show.passwords | Tells fleet to show passwords in plain text in its logs. Not recommended. |
fleet.nuke.database | Be very careful. This will tell Fleet to completely wipe and rebuild its database. This can be useful if the owner deems the database to be too far out of synchronisation with Docker Hub, or if images have since been removed but are still showing in Fleet. |
fleet.skip.sync.on.startup | By default, Fleet will run a synchronisation process when it first starts up. Setting this flag will tell it to skip the first run. The next synchronisation will be at the set interval. |
Default User¶
When starting Fleet for the first time it will create a default user in order for you to log in and manage the repositories/images synchronised by the application. The default username and password are:
Username: admin
Password: admin
{% hint style="warning" %} You should change the default password for this user as soon as possible! This can be done via the Admin -> Users menu options.
Running LinuxServer Containers¶
Image Structure¶
Base Images¶
We have curated various base images which our main application images derive from. This is beneficial for two main reasons:
- A common dependency base between multiple images, reducing the likelihood of variation between two or more applications that share the same dependencies.
- Reduction in image footprint on your host machine by fully utilising Docker's image layering system. Multiple containers running locally that share the same base image will reuse that image and any of its ancestors.
The /config volume¶
To help reduce variation between our images, we have adopted a common structure pattern for application config and dependent directories. This means that each image has its own internal /config directory which holds all application-specific configuration. With the exception of a small number of images, all of our images expose this volume.
We do this because we believe that it makes it easier to answer the common question of "where does the application data get persisted?" - the answer being "always in /config". If you don't map this directory when creating your containers, the config will only last as long as the lifespan of the container itself!
Creating a Container¶
To create a container from one of our images, you must use either docker create or docker run. Each image follows the same pattern in the command when creating a container:
docker create \
+ Running LinuxServer Containers - LinuxServer.io Running LinuxServer Containers¶
Image Structure¶
Base Images¶
We have curated various base images which our main application images derive from. This is beneficial for two main reasons:
- A common dependency base between multiple images, reducing the likelihood of variation between two or more applications that share the same dependencies.
- Reduction in image footprint on your host machine by fully utilising Docker's image layering system. Multiple containers running locally that share the same base image will reuse that image and any of its ancestors.
The /config volume¶
To help reduce variation between our images, we have adopted a common structure pattern for application config and dependent directories. This means that each image has its own internal /config directory which holds all application-specific configuration. With the exception of a small number of images, all of our images expose this volume.
We do this because we believe that it makes it easier to answer the common question of "where does the application data get persisted?" - the answer being "always in /config". If you don't map this directory when creating your containers, the config will only last as long as the lifespan of the container itself!
Creating a Container¶
To create a container from one of our images, you must use either docker create or docker run. Each image follows the same pattern in the command when creating a container:
\ No newline at end of file
+SWAG¶
The goal of this guide is to give you ideas on what can be accomplished with the LinuxServer SWAG docker image and to get you started. We will explain some of the basic concepts and limitations, and then we'll provide you with common examples. If you have further questions, you can ask on our forum or join our Discord for conversations: https://discord.gg/YWrKVTn
Table of Contents¶
- SWAG
- Table of Contents
- Introduction
- Creating a SWAG container
- Container setup examples
- Web hosting examples
- Reverse Proxy
- Troubleshooting
- Final Thoughts
Introduction¶
What are SSL certs?¶
SSL certs allow users of a service to communicate via encrypted data transmitted up and down. Third party trusted certs also allow users to make sure that the remote service they are connecting to is really who they say they are and not someone else in the middle. When we run a web server for reasons like hosting websites or reverse proxying services on our own domain, we need to set it up with third party trusted ssl certs so client browsers trust it and communicate with it securely. When you connect to a website with a trusted cert, most browsers show a padlock icon next to the address bar to indicate that. Without a trusted cert (ie. with self signed cert) most browsers show warning pages or may block access to the website as the website identity cannot be confirmed via a trusted third party.
What is Let's Encrypt (and/or ZeroSSL)?¶
In the past, the common way to get a trusted ssl cert was to contact one of the providers, send them the relevant info to prove ownership of a domain and pay for the service. Nowadays, with Let's Encrypt and ZeroSSL, one can get free certs via automated means.
The SWAG docker image, published and maintained by LinuxServer.io, makes setting up a full-fledged web server with auto generated and renewed ssl certs very easy. It is essentially an nginx webserver with php7, fail2ban (intrusion prevention) and Let's Encrypt cert validation built-in. It is just MySQL short of a LEMP stack and therefore is best paired with our MariaDB docker image.
Creating a SWAG container¶
Most of the initial settings for getting a webserver with ssl certs up are done through the docker run/create or compose yaml parameters. Here's a list of all the settings available including the optional ones. It is safe to remove unnecessary parameters for different scenarios.
docker cli¶
docker create \
+ SWAG - LinuxServer.io SWAG¶
The goal of this guide is to give you ideas on what can be accomplished with the LinuxServer SWAG docker image and to get you started. We will explain some of the basic concepts and limitations, and then we'll provide you with common examples. If you have further questions, you can ask on our forum or join our Discord for conversations: https://discord.gg/YWrKVTn
Table of Contents¶
- SWAG
- Table of Contents
- Introduction
- Creating a SWAG container
- Container setup examples
- Web hosting examples
- Reverse Proxy
- Troubleshooting
- Final Thoughts
Introduction¶
What are SSL certs?¶
SSL certs allow users of a service to communicate via encrypted data transmitted up and down. Third party trusted certs also allow users to make sure that the remote service they are connecting to is really who they say they are and not someone else in the middle. When we run a web server for reasons like hosting websites or reverse proxying services on our own domain, we need to set it up with third party trusted ssl certs so client browsers trust it and communicate with it securely. When you connect to a website with a trusted cert, most browsers show a padlock icon next to the address bar to indicate that. Without a trusted cert (ie. with self signed cert) most browsers show warning pages or may block access to the website as the website identity cannot be confirmed via a trusted third party.
What is Let's Encrypt (and/or ZeroSSL)?¶
In the past, the common way to get a trusted ssl cert was to contact one of the providers, send them the relevant info to prove ownership of a domain and pay for the service. Nowadays, with Let's Encrypt and ZeroSSL, one can get free certs via automated means.
The SWAG docker image, published and maintained by LinuxServer.io, makes setting up a full-fledged web server with auto generated and renewed ssl certs very easy. It is essentially an nginx webserver with php7, fail2ban (intrusion prevention) and Let's Encrypt cert validation built-in. It is just MySQL short of a LEMP stack and therefore is best paired with our MariaDB docker image.
Creating a SWAG container¶
Most of the initial settings for getting a webserver with ssl certs up are done through the docker run/create or compose yaml parameters. Here's a list of all the settings available including the optional ones. It is safe to remove unnecessary parameters for different scenarios.
docker cli¶
That way, nginx will use the / location block from our heimdall proxy conf instead.
After that, when we navigate to https://linuxserver-test.com, we'll see the Heimdall interface.
If we want to password protect our new homepage, we can run the following on the host command line to create a new .htpasswd file: docker exec -it swag htpasswd -c /config/nginx/.htpasswd anyusername. After which, we can activate authentication by editing the heimdall.subfolder.conf file to uncomment the relevant lines so it reads:
# enable the next two lines for http auth
auth_basic "Restricted";
auth_basic_user_file /config/nginx/.htpasswd;
-
Troubleshooting¶
We wrote a blogpost for the deprecated letsencrypt image diving into troubleshooting issues regarding dns and port-forwards, which still is a very good resource: blog.linuxserver.io
Common errors¶
404¶
This error simply means that the resource was not found. Commonly happening when you try to access a subfolder that is not enabled.
502¶
This error means that nginx can't talk to the application. There is a few common reasons for this:
-
The application and SWAG is not on the same custom docker network
Further up we talk about how to set up Docker networking, however there are some other common traps
-
The container name does not match the application name.
Covered in the section for Understanding the proxy conf structure
-
You manually changed the port.
Also covered in the section for Understanding the proxy conf structure
-
The container originally ran with host networking, or the default bridge.
In most cases the contents of /config/nginx/resolver.conf; should be ...resolver 127.0.0.11 valid=30s;, if this is not the case, you can:
-
Delete it, and restart the container to have it regenerate
- Manually set the content(we wont override it)
Final Thoughts¶
This image can be used in many different scenarios as it is a full fledged web server with some bells and whistles added. The above examples should be enough to get you started. For more information, please refer to the official documentation on either Github or Docker Hub. If you have questions or issues, or want to discuss and share ideas, feel free to visit our discord: https://discord.gg/YWrKVTn
How to Request Support¶
As you can see in this article, there are many different configurations, therefore we need to understand your exact setup before we can provide support. If you encounter a bug and confirm that it's a bug, please report it on our github thread. If you need help with setting it up, join our discord and upload the following info to a service like pastebin and post the link:
- Docker run/create or compose yml you used
- Full docker log (
docker logs swag) - Any relevant conf files (default, nginx.conf or specific proxy conf)
\ No newline at end of file
+Troubleshooting¶
We wrote a blogpost for the deprecated letsencrypt image diving into troubleshooting issues regarding dns and port-forwards, which still is a very good resource: blog.linuxserver.io
Common errors¶
404¶
This error simply means that the resource was not found. Commonly happening when you try to access a subfolder that is not enabled.
502¶
This error means that nginx can't talk to the application. There is a few common reasons for this:
-
The application and SWAG is not on the same custom docker network
Further up we talk about how to set up Docker networking, however there are some other common traps
-
The container name does not match the application name.
Covered in the section for Understanding the proxy conf structure
-
You manually changed the port.
Also covered in the section for Understanding the proxy conf structure
-
The container originally ran with host networking, or the default bridge.
In most cases the contents of
/config/nginx/resolver.conf;should be...resolver 127.0.0.11 valid=30s;, if this is not the case, you can: -
Delete it, and restart the container to have it regenerate
- Manually set the content(we wont override it)
Final Thoughts¶
This image can be used in many different scenarios as it is a full fledged web server with some bells and whistles added. The above examples should be enough to get you started. For more information, please refer to the official documentation on either Github or Docker Hub. If you have questions or issues, or want to discuss and share ideas, feel free to visit our discord: https://discord.gg/YWrKVTn
How to Request Support¶
As you can see in this article, there are many different configurations, therefore we need to understand your exact setup before we can provide support. If you encounter a bug and confirm that it's a bug, please report it on our github thread. If you need help with setting it up, join our discord and upload the following info to a service like pastebin and post the link:
- Docker run/create or compose yml you used
- Full docker log (
docker logs swag) - Any relevant conf files (default, nginx.conf or specific proxy conf)
Understanding PUID and PGID¶
{% hint style="info" %} We are aware that recent versions of the Docker engine have introduced the --user flag. Our images are not yet compatible with this, so we recommend continuing usage of PUID and PGID.
Why use these?¶
Docker runs all of its containers under the root user domain because it requires access to things like network configuration, process management, and your filesystem. This means that the processes running inside your containers also run as root. This kind of elevated access is not ideal for day-to-day use, and potentially gives applications the access to things they shouldn't (although, a strong understanding of volume and port mapping will help with this).
Another issue is file management within the container's mapped volumes. If the process is running under root, all files and directories created during the container's lifespan will be owned by root, thus becoming inaccessible by you.
Using the PUID and PGID allows our containers to map the container's internal user to a user on the host machine. All of our containers use this method of user mapping and should be applied accordingly.
Using the variables¶
When creating a container from one of our images, ensure you use the -e PUID and -e PGID options in your docker command:
docker create --name=beets -e PUID=1000 -e PGID=1000 linuxserver/beets
+ Understanding PUID and PGID - LinuxServer.io Understanding PUID and PGID¶
{% hint style="info" %} We are aware that recent versions of the Docker engine have introduced the --user flag. Our images are not yet compatible with this, so we recommend continuing usage of PUID and PGID.
Why use these?¶
Docker runs all of its containers under the root user domain because it requires access to things like network configuration, process management, and your filesystem. This means that the processes running inside your containers also run as root. This kind of elevated access is not ideal for day-to-day use, and potentially gives applications the access to things they shouldn't (although, a strong understanding of volume and port mapping will help with this).
Another issue is file management within the container's mapped volumes. If the process is running under root, all files and directories created during the container's lifespan will be owned by root, thus becoming inaccessible by you.
Using the PUID and PGID allows our containers to map the container's internal user to a user on the host machine. All of our containers use this method of user mapping and should be applied accordingly.
Using the variables¶
When creating a container from one of our images, ensure you use the -e PUID and -e PGID options in your docker command:
Or, if you use docker-compose, add them to the environment: section:
It is most likely that you will use the id of yourself, which can be obtained by running the command below. The two values you will be interested in are the uid and gid.
\ No newline at end of file
+Updating our containers¶
Our images are updated whenever the upstream application or dependencies get changed, so make sure you're always running the latest version, as they may contain important bug fixes and new features.
Steps required to update¶
Docker containers are, for the most part, immutable. This means that important configuration such as volume and port mappings can't be easily changed once the container has been created. The containers created from our images run a very specific version of the application they wrap, so in order to update the application, you must recreate the container.
Stop the container¶
Firstly, stop the container.
docker stop <container_name>
+ Updating our containers - LinuxServer.io Updating our containers¶
Our images are updated whenever the upstream application or dependencies get changed, so make sure you're always running the latest version, as they may contain important bug fixes and new features.
Steps required to update¶
Docker containers are, for the most part, immutable. This means that important configuration such as volume and port mappings can't be easily changed once the container has been created. The containers created from our images run a very specific version of the application they wrap, so in order to update the application, you must recreate the container.
Stop the container¶
Firstly, stop the container.
Remove the container¶
Once the container has been stopped, remove it.
Important: Did you remember to persist the /config volume when you originally created the container? Bear in mind, you'll lose any configuration inside the container if this volume was not persisted. Read up on why this is important.
Pull the latest version¶
Now you can pull the latest version of the application image from Docker Hub.
Recreate the container¶
Finally, you can recreate the container. This is often cited as the most arduous task as it requires you to remember all of the mappings you set beforehand. You can help mitigate this step by using Docker Compose instead - this topic has been outlined in our documentation.
Or, to update all containers at once:
Removing old images¶
Whenever a Docker image is updated, a fresh version of that image gets downloaded and stored on your host machine. Doing this, however, does not remove the old version of the image. Eventually you will end up with a lot of disk space used up by stale images. You can prune old images from your system, which will free up space:
\ No newline at end of file
+Volumes¶
In Docker terminology, a volume is a storage device that allows you to persist the data used and generated by each of your running containers. While a container remains alive (in either an active or inactive state), the data inside its user-space remains intact. However, if you decide to recreate a container, all data within that container is lost. Volumes are an intrinsic aspect of container management, so it is useful to know how to create them.
There are two ways to map persistent storage to your containers; container volumes, and directory overlays. All of our images reference persistent data by means of directory overlays.
Mapping a volume to your container¶
Firstly, you must understand which directories from within your container you wish to persist. All of our images come with side-by-side documentation on which internal directories are used by the application. As mentioned in the Running our Containers documentation, the most common directory you will wish to persist is the /config directory.
Before you create your container, first create a directory on the host machine that will act as the home for your persisted data. We recommend creating the directory /opt/appdata. Under this tree, you can create a single configuration directory for each of your containers.
When creating the container itself, now is the time to make use of the -v flag, which will tell Docker to overlay your host directory over the container's directory:
docker create --name my_container \
+ Volumes - LinuxServer.io Volumes¶
In Docker terminology, a volume is a storage device that allows you to persist the data used and generated by each of your running containers. While a container remains alive (in either an active or inactive state), the data inside its user-space remains intact. However, if you decide to recreate a container, all data within that container is lost. Volumes are an intrinsic aspect of container management, so it is useful to know how to create them.
There are two ways to map persistent storage to your containers; container volumes, and directory overlays. All of our images reference persistent data by means of directory overlays.
Mapping a volume to your container¶
Firstly, you must understand which directories from within your container you wish to persist. All of our images come with side-by-side documentation on which internal directories are used by the application. As mentioned in the Running our Containers documentation, the most common directory you will wish to persist is the /config directory.
Before you create your container, first create a directory on the host machine that will act as the home for your persisted data. We recommend creating the directory /opt/appdata. Under this tree, you can create a single configuration directory for each of your containers.
When creating the container itself, now is the time to make use of the -v flag, which will tell Docker to overlay your host directory over the container's directory:
The above example shows how the usage of -v has mapped the host machine's /opt/appdata/my_config directory over the container's internal /config directory.
Remember: When dealing with mapping overlays, it always reads host:container
You can do this for as many directories as required by either you or the container itself. Our rule-of-thumb is to always map the /config directory as this contains pertinent runtime configuration for the underlying application. For applications that require further data, such as media, our documentation will clearly indicate which internal directories need mapping.
\ No newline at end of file
+The above example shows how the usage of -v has mapped the host machine's /opt/appdata/my_config directory over the container's internal /config directory.
Remember: When dealing with mapping overlays, it always reads
host:container
You can do this for as many directories as required by either you or the container itself. Our rule-of-thumb is to always map the /config directory as this contains pertinent runtime configuration for the underlying application. For applications that require further data, such as media, our documentation will clearly indicate which internal directories need mapping.
linuxserver/adguardhome-sync¶
Adguardhome-sync is a tool to synchronize AdGuardHome config to replica instances.
Supported Architectures¶
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/adguardhome-sync:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
| Tag | Available | Description |
|---|---|---|
| latest | ✅ | Stable releases from GitHub |
| ## Application Setup |
Edit the adguardhome-sync.yaml with your AdGuardHome instance details, for more information check out AdGuardHome Sync.
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)¶
---
+ adguardhome-sync - LinuxServer.io linuxserver/adguardhome-sync¶
Adguardhome-sync is a tool to synchronize AdGuardHome config to replica instances.
Supported Architectures¶
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/adguardhome-sync:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
Tag Available Description latest ✅ Stable releases from GitHub ## Application Setup
Edit the adguardhome-sync.yaml with your AdGuardHome instance details, for more information check out AdGuardHome Sync.
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)¶
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 8080Port for AdGuardHome Sync's web API.
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. CONFIGFILE=/config/adguardhome-sync.yamlSet a custom config file.
Volume Mappings (-v)¶
Volume Function /configContains all relevant configuration files.
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:
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:
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 adguardhome-sync /bin/bash- To monitor the logs of the container in realtime:
docker logs -f adguardhome-sync- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' adguardhome-sync- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/adguardhome-sync:latest
Versions¶
- 11.06.23: - Rebase to Alpine 3.18, deprecate armhf.
- 07.02.23: - Rebase to Alpine 3.17, update amd64 artifact name.
- 03.10.22: - Rebase to Alpine 3.16, migrate to s6v3.
- 18.12.21: - Rebase to Alpine 3.15.
- 09.08.21: - Rebase to Alpine 3.14.
- 08.04.21: - Initial Release.
\ No newline at end of file
+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 adguardhome-sync /bin/bash- To monitor the logs of the container in realtime:
docker logs -f adguardhome-sync- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' adguardhome-sync- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/adguardhome-sync:latest
Versions¶
- 11.06.23: - Rebase to Alpine 3.18, deprecate armhf.
- 07.02.23: - Rebase to Alpine 3.17, update amd64 artifact name.
- 03.10.22: - Rebase to Alpine 3.16, migrate to s6v3.
- 18.12.21: - Rebase to Alpine 3.15.
- 09.08.21: - Rebase to Alpine 3.14.
- 08.04.21: - Initial Release.
linuxserver/airsonic-advanced¶
Airsonic-advanced is a free, web-based media streamer, providing ubiquitious access to your music. Use it to share your music with friends, or to listen to your own music while at work. You can stream to multiple players simultaneously, for instance to one player in your kitchen and another in your living room.
Supported Architectures¶
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/airsonic-advanced:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
We don't formally support upgrading from Airsonic to Airsonic Advanced, it may or may not work for you and we'd recommend making backups before attempting this. Following the upgrade you may experience a forced rescan of your library so take this into account if you have a lot of files.
Please see notes about upgrading from v10 to v11 here
Access WebUI at <your-ip>:4040.
Default user/pass is admin/admin
Extra java options can be passed with the JAVA_OPTS environment variable, eg -e JAVA_OPTS="-Xmx256m -Xms256m". For some reverse proxies, you may need to pass JAVA_OPTS=-Dserver.use-forward-headers=true for airsonic to generate the proper URL schemes.
Note that if you want to use Airsonic's Java jukebox player, then PGID will need to match the group of your sound device (e.g. /dev/snd).
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)¶
---
+ airsonic-advanced - LinuxServer.io linuxserver/airsonic-advanced¶
Airsonic-advanced is a free, web-based media streamer, providing ubiquitious access to your music. Use it to share your music with friends, or to listen to your own music while at work. You can stream to multiple players simultaneously, for instance to one player in your kitchen and another in your living room.
Supported Architectures¶
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/airsonic-advanced:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
We don't formally support upgrading from Airsonic to Airsonic Advanced, it may or may not work for you and we'd recommend making backups before attempting this. Following the upgrade you may experience a forced rescan of your library so take this into account if you have a lot of files.
Please see notes about upgrading from v10 to v11 here
Access WebUI at <your-ip>:4040.
Default user/pass is admin/admin
Extra java options can be passed with the JAVA_OPTS environment variable, eg -e JAVA_OPTS="-Xmx256m -Xms256m". For some reverse proxies, you may need to pass JAVA_OPTS=-Dserver.use-forward-headers=true for airsonic to generate the proper URL schemes.
Note that if you want to use Airsonic's Java jukebox player, then PGID will need to match the group of your sound device (e.g. /dev/snd).
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)¶
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 4040WebUI
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. CONTEXT_PATH=For setting url-base in reverse proxy setups. JAVA_OPTS=For passing additional java options.
Volume Mappings (-v)¶
Volume Function /configConfiguration file location. /musicLocation of music. /playlistsLocation for playlists to be saved to. /podcastsLocation of podcasts. /mediaLocation of other media.
Device Mappings (--device)¶
Parameter Function /dev/sndOnly needed to pass your host sound device to Airsonic's Java jukebox player.
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:
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:
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 airsonic-advanced /bin/bash- To monitor the logs of the container in realtime:
docker logs -f airsonic-advanced- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' airsonic-advanced- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/airsonic-advanced:latest
Versions¶
- 30.05.23: - Rebase to Alpine 3.18.
- 11.02.23: - Rebase to Alpine 3.17.
- 23.10.22: - Rebase to Alpine 3.16, migrate to s6v3.
- 25.07.22: - Add vorbis-tools.
- 02.01.22: - Initial Release.
\ No newline at end of file
+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 airsonic-advanced /bin/bash- To monitor the logs of the container in realtime:
docker logs -f airsonic-advanced- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' airsonic-advanced- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/airsonic-advanced:latest
Versions¶
- 30.05.23: - Rebase to Alpine 3.18.
- 11.02.23: - Rebase to Alpine 3.17.
- 23.10.22: - Rebase to Alpine 3.16, migrate to s6v3.
- 25.07.22: - Add vorbis-tools.
- 02.01.22: - Initial Release.
DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. We recommend our airsonic-advanced image instead: https://github.com/linuxserver/docker-airsonic-advanced
linuxserver/airsonic¶
Airsonic is a free, web-based media streamer, providing ubiquitious access to your music. Use it to share your music with friends, or to listen to your own music while at work. You can stream to multiple players simultaneously, for instance to one player in your kitchen and another in your living room.
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/airsonic 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 | amd64-latest |
| arm64 | arm64v8-latest |
| armhf | arm32v7-latest |
Application Setup¶
Access WebUI at <your-ip>:4040.
Default user/pass is admin/admin
Extra java options can be passed with the JAVA_OPTS environment variable, eg -e JAVA_OPTS="-Xmx256m -Xms256m". For some reverse proxies, you may need to pass JAVA_OPTS=-Dserver.use-forward-headers=true for airsonic to generate the proper URL schemes.
Note that if you want to use Airsonic's Java jukebox player, then PGID will need to match the group of your sound device (e.g. /dev/snd).
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)¶
---
+ airsonic - LinuxServer.io DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. We recommend our airsonic-advanced image instead: https://github.com/linuxserver/docker-airsonic-advanced
linuxserver/airsonic¶
Airsonic is a free, web-based media streamer, providing ubiquitious access to your music. Use it to share your music with friends, or to listen to your own music while at work. You can stream to multiple players simultaneously, for instance to one player in your kitchen and another in your living room.
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/airsonic 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 amd64-latest arm64 arm64v8-latest armhf arm32v7-latest
Application Setup¶
Access WebUI at <your-ip>:4040.
Default user/pass is admin/admin
Extra java options can be passed with the JAVA_OPTS environment variable, eg -e JAVA_OPTS="-Xmx256m -Xms256m". For some reverse proxies, you may need to pass JAVA_OPTS=-Dserver.use-forward-headers=true for airsonic to generate the proper URL schemes.
Note that if you want to use Airsonic's Java jukebox player, then PGID will need to match the group of your sound device (e.g. /dev/snd).
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)¶
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 4040WebUI
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Europe/LondonSpecify a timezone to use EG Europe/London. CONTEXT_PATH=<URL_BASE>For setting url-base in reverse proxy setups. JAVA_OPTS=<options>For passing additional java options.
Volume Mappings (-v)¶
Volume Function /configConfiguration file location. /musicLocation of music. /playlistsLocation for playlists to be saved to. /podcastsLocation of podcasts. /mediaLocation of other media.
Device Mappings (--device)¶
Parameter Function /dev/sndOnly needed to pass your host sound device to Airsonic's Java jukebox player.
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:
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:
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 airsonic /bin/bash- To monitor the logs of the container in realtime:
docker logs -f airsonic- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' airsonic- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/airsonic
Versions¶
- 13.01.22: - Deprecate in favor of airsonic-advanced.
- 24.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 26.01.19: - Add pipeline logic and multi arch.
- 05.01.19: - Linting fixes.
- 27.08.18: - Use new inhouse java baseimage for quicker builds.
- 23.08.18: - Rebase to ubuntu bionic for increased performance across all arch's.
- 22.04.18: - Add the forgotten JAVA_OPTS to the run command.
- 29.12.17: - Initial Release.
\ No newline at end of file
+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 airsonic /bin/bash- To monitor the logs of the container in realtime:
docker logs -f airsonic- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' airsonic- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/airsonic
Versions¶
- 13.01.22: - Deprecate in favor of airsonic-advanced.
- 24.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 26.01.19: - Add pipeline logic and multi arch.
- 05.01.19: - Linting fixes.
- 27.08.18: - Use new inhouse java baseimage for quicker builds.
- 23.08.18: - Rebase to ubuntu bionic for increased performance across all arch's.
- 22.04.18: - Add the forgotten JAVA_OPTS to the run command.
- 29.12.17: - Initial Release.
linuxserver/apprise-api¶
Apprise-api Takes advantage of Apprise through your network with a user-friendly API.
- Send notifications to more then 65+ services.
- An incredibly lightweight gateway to Apprise.
- A production ready micro-service at your disposal.
Apprise API was designed to easily fit into existing (and new) eco-systems that are looking for a simple notification solution.
Supported Architectures¶
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/apprise-api:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
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)¶
---
+ apprise-api - LinuxServer.io linuxserver/apprise-api¶
Apprise-api Takes advantage of Apprise through your network with a user-friendly API.
- Send notifications to more then 65+ services.
- An incredibly lightweight gateway to Apprise.
- A production ready micro-service at your disposal.
Apprise API was designed to easily fit into existing (and new) eco-systems that are looking for a simple notification solution.
Supported Architectures¶
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/apprise-api:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
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)¶
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 8000Port for apprise's interface and API.
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configWhere config is stored.
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:
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:
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 apprise-api /bin/bash- To monitor the logs of the container in realtime:
docker logs -f apprise-api- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' apprise-api- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/apprise-api:latest
Versions¶
- 10.07.23: - Rebase to Alpine 3.18.
- 01.07.23: - Deprecate armhf. As announced here
- 11.02.23: - Rebase to Alpine 3.17.
- 17.10.22: - Rebase to alpine 3.16, migrate to S6V3
- 28.02.21: - Rebase to alpine 3.15.
- 03.11.21: - Increase uWSGI buffer size to 32kb.
- 16.05.21: - Add linuxserver wheel index.
- 26.02.21: - Initial Release.
\ No newline at end of file
+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 apprise-api /bin/bash- To monitor the logs of the container in realtime:
docker logs -f apprise-api- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' apprise-api- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/apprise-api:latest
Versions¶
- 10.07.23: - Rebase to Alpine 3.18.
- 01.07.23: - Deprecate armhf. As announced here
- 11.02.23: - Rebase to Alpine 3.17.
- 17.10.22: - Rebase to alpine 3.16, migrate to S6V3
- 28.02.21: - Rebase to alpine 3.15.
- 03.11.21: - Increase uWSGI buffer size to 32kb.
- 16.05.21: - Add linuxserver wheel index.
- 26.02.21: - Initial Release.
linuxserver/audacity¶
Audacity is an easy-to-use, multi-track audio editor and recorder. Developed by a group of volunteers as open source.
Supported Architectures¶
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/audacity:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ❌ | |
| armhf | ❌ |
Application Setup¶
The application can be accessed at:
- http://yourhost:3000/
- https://yourhost:3001/
Options in all KasmVNC based GUI containers¶
This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.
Optional environment variables¶
| Variable | Description |
|---|---|
| CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default 3000. |
| CUSTOM_HTTPS_PORT | Internal port the container listens on for https if it needs to be swapped from the default 3001. |
| CUSTOM_USER | HTTP Basic auth username, abc is default. |
| PASSWORD | HTTP Basic auth password, abc is default. If unset there will be no auth |
| SUBFOLDER | Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/ |
| TITLE | The page title displayed on the web browser, default "KasmVNC Client". |
| FM_HOME | This is the home directory (landing) for the file manager, default "/config". |
| START_DOCKER | If set to false a container with privilege will not automatically start the DinD Docker setup. |
| DRINODE | If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE /dev/dri/renderD128 |
Optional run configurations¶
| Variable | Description |
|---|---|
--privileged | Will start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE -v /home/user/docker-data:/var/lib/docker. |
-v /var/run/docker.sock:/var/run/docker.sock | Mount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. |
--device /dev/dri:/dev/dri | Mount a GPU into the container, this can be used in conjunction with the DRINODE environment variable to leverage a host video card for GPU accelerated appplications. Only Open Source drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau) |
Lossless mode¶
This container is capable of delivering a true lossless image at a high framerate to your web browser by changing the Stream Quality preset to "Lossless", more information here. In order to use this mode from a non localhost endpoint the HTTPS port on 3001 needs to be used. If using a reverse proxy to port 3000 specific headers will need to be set as outlined here.
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)¶
---
+ audacity - LinuxServer.io linuxserver/audacity¶
Audacity is an easy-to-use, multi-track audio editor and recorder. Developed by a group of volunteers as open source.
Supported Architectures¶
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/audacity:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ❌ armhf ❌
Application Setup¶
The application can be accessed at:
- http://yourhost:3000/
- https://yourhost:3001/
Options in all KasmVNC based GUI containers¶
This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.
Optional environment variables¶
Variable Description CUSTOM_PORT Internal port the container listens on for http if it needs to be swapped from the default 3000. CUSTOM_HTTPS_PORT Internal port the container listens on for https if it needs to be swapped from the default 3001. CUSTOM_USER HTTP Basic auth username, abc is default. PASSWORD HTTP Basic auth password, abc is default. If unset there will be no auth SUBFOLDER Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/ TITLE The page title displayed on the web browser, default "KasmVNC Client". FM_HOME This is the home directory (landing) for the file manager, default "/config". START_DOCKER If set to false a container with privilege will not automatically start the DinD Docker setup. DRINODE If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE /dev/dri/renderD128
Optional run configurations¶
Variable Description --privilegedWill start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE -v /home/user/docker-data:/var/lib/docker. -v /var/run/docker.sock:/var/run/docker.sockMount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. --device /dev/dri:/dev/driMount a GPU into the container, this can be used in conjunction with the DRINODE environment variable to leverage a host video card for GPU accelerated appplications. Only Open Source drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau)
Lossless mode¶
This container is capable of delivering a true lossless image at a high framerate to your web browser by changing the Stream Quality preset to "Lossless", more information here. In order to use this mode from a non localhost endpoint the HTTPS port on 3001 needs to be used. If using a reverse proxy to port 3000 specific headers will need to be set as outlined here.
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)¶
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 3000Audacity desktop gui. 3001Audacity desktop gui HTTPS.
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configUsers home directory in the container, stores program settings and images
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:
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:
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 audacity /bin/bash- To monitor the logs of the container in realtime:
docker logs -f audacity- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' audacity- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/audacity:latest
Versions¶
- 05.05.23: - Start Audacity in full screen.
- 18.03.23: - Rebase to KasmVNC base image.
- 13.12.22: - Rebase to Jammy.
- 14.09.21: - Use the official appimage, switch to single arch (x86_64). Armhf and aarch64 users can remain on version 3.0.2 but there won't be further updates.
- 07.04.21: - Initial release.
\ No newline at end of file
+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 audacity /bin/bash- To monitor the logs of the container in realtime:
docker logs -f audacity- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' audacity- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/audacity:latest
Versions¶
- 05.05.23: - Start Audacity in full screen.
- 18.03.23: - Rebase to KasmVNC base image.
- 13.12.22: - Rebase to Jammy.
- 14.09.21: - Use the official appimage, switch to single arch (x86_64). Armhf and aarch64 users can remain on version 3.0.2 but there won't be further updates.
- 07.04.21: - Initial release.
linuxserver/babybuddy¶
Babybuddy is a buddy for babies! Helps caregivers track sleep, feedings, diaper changes, tummy time and more to learn about and predict baby's needs without (as much) guess work.
Supported Architectures¶
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/babybuddy:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
Access the webui at <your-ip>:8000 (or whichever host port is mapped in docker arguments). The default user/pass are admin:admin.
By default BabyBuddy uses sqlite3. To use an external database like postgresql or mysql/mariadb instead, you can use the environment variables listed in BabyBuddy docs.
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)¶
---
+ babybuddy - LinuxServer.io linuxserver/babybuddy¶
Babybuddy is a buddy for babies! Helps caregivers track sleep, feedings, diaper changes, tummy time and more to learn about and predict baby's needs without (as much) guess work.
Supported Architectures¶
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/babybuddy:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
Access the webui at <your-ip>:8000 (or whichever host port is mapped in docker arguments). The default user/pass are admin:admin.
By default BabyBuddy uses sqlite3. To use an external database like postgresql or mysql/mariadb instead, you can use the environment variables listed in BabyBuddy docs.
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)¶
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 8000the port for the web ui
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. CSRF_TRUSTED_ORIGINS=http://127.0.0.1:8000,https://babybuddy.domain.comAdd any address you'd like to access babybuddy at (comma separated, no spaces)
Volume Mappings (-v)¶
Volume Function /configContains all relevant configuration and data.
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:
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:
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 babybuddy /bin/bash- To monitor the logs of the container in realtime:
docker logs -f babybuddy- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' babybuddy- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/babybuddy:latest
Versions¶
- 05.07.23: - Add standard HTTP/HTTPS listen ports 80 and 443, keeping 8000 for backwards compatibility.
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 16.01.23: - Rebase to Alpine 3.17.
- 23.11.22: - Rebase to Alpine 3.16, migrate to s6v3. Restructure nginx configs (see changes announcement).
- 28.05.22: - Add missing PUID/PGID vars to readme.
- 03.04.22: - Rebase to alpine-nginx baseimage. Add
CSRF_TRUSTED_ORIGINS env var. - 11.12.21: - Add py3-mysqlclient for mysql/mariadb.
- 14.11.21: - Add lxml dependencies (temp fix for amd64 by force compiling lxml).
- 25.07.21: - Add libpq for postgresql.
- 08.07.21: - Fix pip install issue.
- 05.07.21: - Update Gunicorn parameters to prevent
WORKER_TIMEOUT issue. - 22.06.21: - Initial release.
\ No newline at end of file
+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 babybuddy /bin/bash- To monitor the logs of the container in realtime:
docker logs -f babybuddy- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' babybuddy- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/babybuddy:latest
Versions¶
- 05.07.23: - Add standard HTTP/HTTPS listen ports 80 and 443, keeping 8000 for backwards compatibility.
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 16.01.23: - Rebase to Alpine 3.17.
- 23.11.22: - Rebase to Alpine 3.16, migrate to s6v3. Restructure nginx configs (see changes announcement).
- 28.05.22: - Add missing PUID/PGID vars to readme.
- 03.04.22: - Rebase to alpine-nginx baseimage. Add
CSRF_TRUSTED_ORIGINSenv var. - 11.12.21: - Add py3-mysqlclient for mysql/mariadb.
- 14.11.21: - Add lxml dependencies (temp fix for amd64 by force compiling lxml).
- 25.07.21: - Add libpq for postgresql.
- 08.07.21: - Fix pip install issue.
- 05.07.21: - Update Gunicorn parameters to prevent
WORKER_TIMEOUTissue. - 22.06.21: - Initial release.
Docker base alpine example
Contact information:-¶
| Type | Address/Details |
|---|---|
| Discord | Discord |
| IRC | freenode at #linuxserver.io more information at:- IRC |
| Forum | Linuserver.io forum |
A custom base image built with Alpine linux and S6 overlay..
The following line is only in this repo for loop testing:
- { date: "01.01.50:", desc: "I am the release message for this internal repo." }
Docker base alpine example
Contact information:-¶
| Type | Address/Details |
|---|---|
| Discord | Discord |
| IRC | freenode at #linuxserver.io more information at:- IRC |
| Forum | Linuserver.io forum |
A custom base image built with Alpine linux and S6 overlay..
The following line is only in this repo for loop testing:
- { date: "01.01.50:", desc: "I am the release message for this internal repo." }
Docker base ubuntu example
Contact information:-¶
| Type | Address/Details |
|---|---|
| Discord | Discord |
| IRC | freenode at #linuxserver.io more information at:- IRC |
| Forum | Linuserver.io forum |
A custom base image built with Ubuntu cloud image and S6 overlay..
The following line is only in this repo for loop testing:
- { date: "01.01.50:", desc: "I am the release message for this internal repo." }
Docker base ubuntu example
Contact information:-¶
| Type | Address/Details |
|---|---|
| Discord | Discord |
| IRC | freenode at #linuxserver.io more information at:- IRC |
| Forum | Linuserver.io forum |
A custom base image built with Ubuntu cloud image and S6 overlay..
The following line is only in this repo for loop testing:
- { date: "01.01.50:", desc: "I am the release message for this internal repo." }
baseimage-alpine-nginx
Contact information:-¶
| Type | Address/Details |
|---|---|
| Discord | Discord |
| IRC | freenode at #linuxserver.io more information at:- IRC |
| Forum | LinuxServer.io forum |
A custom base image built with Alpine linux, nginx and S6 overlay..
Featuring :-
- weekly updates
- security updates
The following line is only in this repo for loop testing: - { date: "01.01.50:", desc: "I am the release message for this internal repo." }
baseimage-alpine-nginx
Contact information:-¶
| Type | Address/Details |
|---|---|
| Discord | Discord |
| IRC | freenode at #linuxserver.io more information at:- IRC |
| Forum | LinuxServer.io forum |
A custom base image built with Alpine linux, nginx and S6 overlay..
Featuring :-
- weekly updates
- security updates
The following line is only in this repo for loop testing: - { date: "01.01.50:", desc: "I am the release message for this internal repo." }
DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. We recommend our standard alpine baseimage instead: https://github.com/linuxserver/docker-baseimage-alpine
Contact information:-¶
| Type | Address/Details |
|---|---|
| Discord | Discord |
| IRC | freenode at #linuxserver.io more information at:- IRC |
| Forum | LinuxServer.io forum |
A custom base image built with Alpine linux, python2 and S6 overlay..
Featuring :-
- weekly updates
- security updates
The following line is only in this repo for loop testing: - { date: "01.01.50:", desc: "I am the release message for this internal repo." }
DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. We recommend our standard alpine baseimage instead: https://github.com/linuxserver/docker-baseimage-alpine
Contact information:-¶
| Type | Address/Details |
|---|---|
| Discord | Discord |
| IRC | freenode at #linuxserver.io more information at:- IRC |
| Forum | LinuxServer.io forum |
A custom base image built with Alpine linux, python2 and S6 overlay..
Featuring :-
- weekly updates
- security updates
The following line is only in this repo for loop testing: - { date: "01.01.50:", desc: "I am the release message for this internal repo." }
baseimage-alpine
Contact information:-¶
| Type | Address/Details |
|---|---|
| Discord | Discord |
| IRC | libera at #linuxserver.io more information at:- IRC |
| Forum | LinuxServer.io forum |
A custom base image built with Alpine linux and S6 overlay..
The following line is only in this repo for loop testing:
- { date: "01.01.50:", desc: "I am the release message for this internal repo." }
baseimage-alpine
Contact information:-¶
| Type | Address/Details |
|---|---|
| Discord | Discord |
| IRC | libera at #linuxserver.io more information at:- IRC |
| Forum | LinuxServer.io forum |
A custom base image built with Alpine linux and S6 overlay..
The following line is only in this repo for loop testing:
- { date: "01.01.50:", desc: "I am the release message for this internal repo." }
baseimage-arch
Contact information:-¶
| Type | Address/Details |
|---|---|
| Discord | Discord |
| IRC | freenode at #linuxserver.io more information at:- IRC |
| Forum | LinuxServer.io forum |
A custom base image built with Alpine linux and S6 overlay..
The following line is only in this repo for loop testing:
- { date: "01.01.50:", desc: "I am the release message for this internal repo." }
baseimage-arch
Contact information:-¶
| Type | Address/Details |
|---|---|
| Discord | Discord |
| IRC | freenode at #linuxserver.io more information at:- IRC |
| Forum | LinuxServer.io forum |
A custom base image built with Alpine linux and S6 overlay..
The following line is only in this repo for loop testing:
- { date: "01.01.50:", desc: "I am the release message for this internal repo." }
DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated.
Contact information:-¶
| Type | Address/Details |
|---|---|
| Discord | Discord |
| IRC | freenode at #linuxserver.io more information at:- IRC |
| Forum | LinuxServer.io forum |
A custom base image built with Ubuntu linux and Cloud9..
The following line is only in this repo for loop testing:
- { date: "01.01.50:", desc: "I am the release message for this internal repo." }
DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated.
Contact information:-¶
| Type | Address/Details |
|---|---|
| Discord | Discord |
| IRC | freenode at #linuxserver.io more information at:- IRC |
| Forum | LinuxServer.io forum |
A custom base image built with Ubuntu linux and Cloud9..
The following line is only in this repo for loop testing:
- { date: "01.01.50:", desc: "I am the release message for this internal repo." }
baseimage-debian
Contact information:-¶
| Type | Address/Details |
|---|---|
| Discord | Discord |
| IRC | freenode at #linuxserver.io more information at:- IRC |
| Forum | LinuxServer.io forum |
A custom base image built with Debian baseimage and S6 overlay..
The following line is only in this repo for loop testing:
- { date: "01.01.50:", desc: "I am the release message for this internal repo." }
baseimage-debian
Contact information:-¶
| Type | Address/Details |
|---|---|
| Discord | Discord |
| IRC | freenode at #linuxserver.io more information at:- IRC |
| Forum | LinuxServer.io forum |
A custom base image built with Debian baseimage and S6 overlay..
The following line is only in this repo for loop testing:
- { date: "01.01.50:", desc: "I am the release message for this internal repo." }
baseimage-fedora
Contact information:-¶
| Type | Address/Details |
|---|---|
| Discord | Discord |
| IRC | freenode at #linuxserver.io more information at:- IRC |
| Forum | LinuxServer.io forum |
A custom base image built with Alpine linux and S6 overlay..
The following line is only in this repo for loop testing:
- { date: "01.01.50:", desc: "I am the release message for this internal repo." }
baseimage-fedora
Contact information:-¶
| Type | Address/Details |
|---|---|
| Discord | Discord |
| IRC | freenode at #linuxserver.io more information at:- IRC |
| Forum | LinuxServer.io forum |
A custom base image built with Alpine linux and S6 overlay..
The following line is only in this repo for loop testing:
- { date: "01.01.50:", desc: "I am the release message for this internal repo." }
DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated.
Contact information:¶
| Type | Address/Details |
|---|---|
| Discord | Discord |
| IRC | freenode at #linuxserver.io more information at:- IRC |
| Forum | LinuxServer.io forum |
linuxserver/docker-baseimage-guacgui¶
A custom graphical base image built with: * Ubuntu cloud image * S6 overlay * xrdp * xorgxrdp * openbox * guacamole
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 linuxserver/docker-baseimage-guacgui 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 | amd64-latest |
| arm64 | arm64v8-latest |
| armhf | arm32v7-latest |
Usage¶
Here are some example snippets to help you get started creating a container.
docker¶
docker create \
+ baseimage-guacgui - LinuxServer.io DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated.
Contact information:¶
Type Address/Details Discord Discord IRC freenode at #linuxserver.io more information at:- IRC Forum LinuxServer.io forum
linuxserver/docker-baseimage-guacgui¶
A custom graphical base image built with: * Ubuntu cloud image * S6 overlay * xrdp * xorgxrdp * openbox * guacamole
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 linuxserver/docker-baseimage-guacgui 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 amd64-latest arm64 arm64v8-latest armhf arm32v7-latest
Usage¶
Here are some example snippets to help you get started creating a container.
docker¶
docker create \
--name=docker-baseimage-guacgui \
-e PUID=1000 \
-e PGID=1000 \
@@ -34,4 +34,4 @@
restart: unless-stopped
Parameters¶
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.
Parameter Function -p 8080Allows HTTP access to the internal X server. -p 3389Allows RDP access to the internal X server. -e PUID=1000for UserID - see below for explanation -e PGID=1000for GroupID - see below for explanation -e TZ=Europe/LondonSpecify a timezone to use EG Europe/London -e APPNAME=xclockSpecify the graphical application name shown on RDP access. -e GUAC_USER=abcSpecify the username for guacamole's web interface. -e GUAC_PASS=900150983cd24fb0d6963f7d28e17f72Specify the password's md5 hash for guacamole's web interface. -e GUAC_KEYBOARD_LAYOUT=de-de-qwertzSpecify the used keyboard layout for the RDP session used by the gucamole client. Possible values are "en-us-qwerty" (default), de-de-qwertz (German keyboard (qwertz)), fr-fr-azerty (French keyboard (azerty)), fr-ch-qwertz (Swiss French keyboard (qwertz)), it-it-qwerty (Italian keyboard), ja-jp-qwerty (Japanese keyboard) and sv-se-qwerty (Swedish keyboard). -v /configContains X user's home directory contents.
Application Setup¶
This is a baseimage meant to be used as base for graphical applications. Please refer to the example folder for usage.
If GUAC_USER and GUAC_PASS are not set, there is no authentication. Passwords can be generated via the following:
Please beware this image is not hardened for internet usage. Use a reverse ssl proxy to increase security. The following line is only in this repo for loop testing: - { date: "01.01.50:", desc: "I am the release message for this internal repo." }
\ No newline at end of file
+The following line is only in this repo for loop testing: - { date: "01.01.50:", desc: "I am the release message for this internal repo." }
DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated.
Contact information:¶
| Type | Address/Details |
|---|---|
| Discord | Discord |
| IRC | freenode at #linuxserver.io more information at:- IRC |
| Forum | LinuxServer.io forum |
linuxserver/docker-baseimage-gui¶
A custom graphical base image built with: * Ubuntu cloud image * S6 overlay * xrdp * xorgxrdp * openbox
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 lsiobase/nginx 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 | amd64-latest |
| arm64 | arm64v8-latest |
| armhf | arm32v7-latest |
Usage¶
Here is an example to help you get started creating a graphical container.
Dockerfile¶
#Firefox via RDP
+ baseimage-gui - LinuxServer.io DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated.
Contact information:¶
Type Address/Details Discord Discord IRC freenode at #linuxserver.io more information at:- IRC Forum LinuxServer.io forum
linuxserver/docker-baseimage-gui¶
A custom graphical base image built with: * Ubuntu cloud image * S6 overlay * xrdp * xorgxrdp * openbox
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 lsiobase/nginx 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 amd64-latest arm64 arm64v8-latest armhf arm32v7-latest
Usage¶
Here is an example to help you get started creating a graphical container.
Dockerfile¶
#Firefox via RDP
FROM lsiobase/ubuntu-gui:amd64-latest
#########################################
@@ -36,4 +36,4 @@
# Execute Firefox
/usr/bin/firefox
-
Access the Graphical Interface¶
Use an RDP client such as: * Remmina * Microsoft Remote Deskotp Client
The following line is only in this repo for loop testing: - { date: "01.01.50:", desc: "I am the release message for this internal repo." }
\ No newline at end of file
+Access the Graphical Interface¶
Use an RDP client such as: * Remmina * Microsoft Remote Deskotp Client
The following line is only in this repo for loop testing: - { date: "01.01.50:", desc: "I am the release message for this internal repo." }
KasmVNC Base Images from LinuxServer¶
The purpose of these images is to provide a full featured web native Linux desktop experience for any Linux application or desktop environment. These images replace our old base images at Rdesktop Web for greatly increased performance, fidelity, and feature set. They ship with passwordless sudo to allow easy package installation, testing, and customization. By default they have no logic to mount out anything but the users home directory, meaning on image updates anything outside of /config will be lost.
These images contain the following services:
- KasmVNC - The core technology for interacting with a containerized desktop from a web browser.
- Kclient - NodeJS Iframe wrapper for KasmVNC providing audio and file access.
- NGINX - Used to serve the mix of KasmVNC and Kclient with the appropriate headers and provide basic auth.
- Docker - Can be used for interacting with a mounted in Docker socket or if the container is run in privileged mode will start a DinD setup.
- PulseAudio - Sound subsystem used to capture audio from the active desktop session and send it to the browser via the Kclient helper application.
Options¶
Authentication for these containers is included as a convenience and to keep in sync with the previous xrdp containers they replace. We use bash to substitute in settings user/password and some strings might break that. In general this authentication mechanism should be used to keep the kids out not the internet
If you are looking for a robust secure application gateway please check out SWAG.
All application settings are passed via environment variables:
| Variable | Description |
|---|---|
| CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default 3000. |
| CUSTOM_HTTPS_PORT | Internal port the container listens on for https if it needs to be swapped from the default 3001. |
| CUSTOM_USER | HTTP Basic auth username, abc is default. |
| PASSWORD | HTTP Basic auth password, abc is default. If unset there will be no auth |
| SUBFOLDER | Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/ |
| TITLE | The page title displayed on the web browser, default "KasmVNC Client". |
| FM_HOME | This is the home directory (landing) for the file manager, default "/config". |
| START_DOCKER | If set to false a container with privilege will not automatically start the DinD Docker setup. |
| DRINODE | If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use |
| DISABLE_IPV6 | If set to true or any value this will disable IPv6 |
Available Distros¶
All base images are built for x86_64 and aarch64 platforms.
| Distro | Current Tag |
|---|---|
| Alpine | alpine317 |
| Arch | arch |
| Debian | debianbullseye |
| Debian | debianbookworm |
| Fedora | fedora38 |
| Ubuntu | ubuntujammy |
I like to read documentation¶
Building images¶
Application containers¶
Included in these base images is a simple Openbox DE and the accompanying logic needed to launch a single application. Lets look at the bare minimum needed to create an application container starting with a Dockerfile:
FROM ghcr.io/linuxserver/baseimage-kasmvnc:alpine318
+ baseimage-kasmvnc - LinuxServer.io KasmVNC Base Images from LinuxServer¶
The purpose of these images is to provide a full featured web native Linux desktop experience for any Linux application or desktop environment. These images replace our old base images at Rdesktop Web for greatly increased performance, fidelity, and feature set. They ship with passwordless sudo to allow easy package installation, testing, and customization. By default they have no logic to mount out anything but the users home directory, meaning on image updates anything outside of /config will be lost.
These images contain the following services:
- KasmVNC - The core technology for interacting with a containerized desktop from a web browser.
- Kclient - NodeJS Iframe wrapper for KasmVNC providing audio and file access.
- NGINX - Used to serve the mix of KasmVNC and Kclient with the appropriate headers and provide basic auth.
- Docker - Can be used for interacting with a mounted in Docker socket or if the container is run in privileged mode will start a DinD setup.
- PulseAudio - Sound subsystem used to capture audio from the active desktop session and send it to the browser via the Kclient helper application.
Options¶
Authentication for these containers is included as a convenience and to keep in sync with the previous xrdp containers they replace. We use bash to substitute in settings user/password and some strings might break that. In general this authentication mechanism should be used to keep the kids out not the internet
If you are looking for a robust secure application gateway please check out SWAG.
All application settings are passed via environment variables:
Variable Description CUSTOM_PORT Internal port the container listens on for http if it needs to be swapped from the default 3000. CUSTOM_HTTPS_PORT Internal port the container listens on for https if it needs to be swapped from the default 3001. CUSTOM_USER HTTP Basic auth username, abc is default. PASSWORD HTTP Basic auth password, abc is default. If unset there will be no auth SUBFOLDER Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/ TITLE The page title displayed on the web browser, default "KasmVNC Client". FM_HOME This is the home directory (landing) for the file manager, default "/config". START_DOCKER If set to false a container with privilege will not automatically start the DinD Docker setup. DRINODE If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use DISABLE_IPV6 If set to true or any value this will disable IPv6
Available Distros¶
All base images are built for x86_64 and aarch64 platforms.
Distro Current Tag Alpine alpine317 Arch arch Debian debianbullseye Debian debianbookworm Fedora fedora38 Ubuntu ubuntujammy
I like to read documentation¶
Building images¶
Application containers¶
Included in these base images is a simple Openbox DE and the accompanying logic needed to launch a single application. Lets look at the bare minimum needed to create an application container starting with a Dockerfile:
And we can define the application to start using:
If included in the build logic it will be launched in place of Openbox. Examples for this kind of configuration can be found in our Webtop repository
Kasm Workspaces compatibility¶
Included in these base images are binary blobs /kasmbins and a special init process /kasminit to maintain compatibility with Kasm Workspaces, If using this base image as reccomended with the startwm.sh or autostart entrypoints. They will be able to be used on that platform without issue.
Docker in Docker (DinD)¶
These base images include an installation of Docker that can be used in two ways. The simple method is simply leveraging the Docker/Docker Compose cli bins to manage the host level Docker installation by mounting in -v /var/run/docker.sock:/var/run/docker.sock.
The base images can also run an isolated in container DinD setup simply by passing --privileged to the container when launching. If for any reason the application needs privilege but Docker is not wanted the -e START_DOCKER=false can be set at runtime or in the Dockerfile. In container Docker (DinD) will most likely use the fuse-overlayfs driver for storage which is not as fast as native overlay2. To increase perormance the /var/lib/docker/ directory in the container can be mounted out to a Linux host and will use overlay2. Keep in mind Docker runs as root and the contents of this directory will not respect the PUID/PGID environment variables available on all LinuxServer.io containers.
DRI3 GPU Acceleration¶
For accelerated apps or games, render devices can be mounted into the container and leveraged by applications using:
--device /dev/dri:/dev/dri
This feature only supports Open Source GPU drivers:
Driver Description Intel i965 and i915 drivers for Intel iGPU chipsets AMD AMDGPU, Radeon, and ATI drivers for AMD dedicated or APU chipsets NVIDIA nouveau2 drivers only, closed source NVIDIA drivers lack DRI3 support
The DRINODE environment variable can be used to point to a specific GPU. Up to date information can be found here
Display Compositing (desktop effects)¶
When using this image in tandem with a supported video card, compositing will function albeit with a performance hit when syncing the frames with pixmaps for the applications using it. This can greatly increase app compatibility if the application in question requires compositing, but requires a real GPU to be mounted into the container. By default we disable compositing at a DE level for performance reasons on our downstream images, but it can be enabled by the user and programs using compositing will still function even if the DE has it disabled in its settings. When building desktop images be sure you understand that with it enabled by default only users that have a compatible GPU mounted in will be able to use your image.
Lossless¶
These images support all the native KasmVNC encoding methods including a true 24 bit RGB lossless mode using the Quite OK Image Format. This mode will use all the bandwidth you give it so just keep that in mind for remote sessions. This mode also might require special configuration depending on how you are accessing the container. Lossless will only work over http (default port 3000) on localhost, when accessing remotely or even over a local network you need to use https (default port 3001) to support SharedArrayBuffer. This is needed to leverage a fast memory pipeline in the browser during the threaded WebAssembly based decoding. This can be enabled in the sidebar under settings>stream quality>lossless.
If putting this container behind a proxy of some kind some headers will need to be set to again support SharedArrayBuffers here is a default NGINX configuration format:
add_header 'Cross-Origin-Embedder-Policy' 'require-corp';
add_header 'Cross-Origin-Opener-Policy' 'same-origin';
add_header 'Cross-Origin-Resource-Policy' 'same-site';
-
More information here
The following line is only in this repo for loop testing: - { date: "01.01.50:", desc: "I am the release message for this internal repo." }
\ No newline at end of file
+More information here
The following line is only in this repo for loop testing: - { date: "01.01.50:", desc: "I am the release message for this internal repo." }
DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. We recommend our Jammy baseimage instead: https://github.com/linuxserver/docker-baseimage-ubuntu
See our Duplicati image for an example using mono: https://github.com/linuxserver/docker-duplicati
Contact information:-¶
| Type | Address/Details |
|---|---|
| Discord | Discord |
| IRC | freenode at #linuxserver.io more information at:- IRC |
| Forum | LinuxServer.io forum |
A custom base image built with Ubuntu cloud image, mono and S6 overlay..
Featuring :-
- weekly updates
- security updates
The following line is only in this repo for loop testing: - { date: "01.01.50:", desc: "I am the release message for this internal repo." }
DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. We recommend our Jammy baseimage instead: https://github.com/linuxserver/docker-baseimage-ubuntu
See our Duplicati image for an example using mono: https://github.com/linuxserver/docker-duplicati
Contact information:-¶
| Type | Address/Details |
|---|---|
| Discord | Discord |
| IRC | freenode at #linuxserver.io more information at:- IRC |
| Forum | LinuxServer.io forum |
A custom base image built with Ubuntu cloud image, mono and S6 overlay..
Featuring :-
- weekly updates
- security updates
The following line is only in this repo for loop testing: - { date: "01.01.50:", desc: "I am the release message for this internal repo." }
DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. This base image has been replaced by: https://github.com/linuxserver/docker-baseimage-kasmvnc
Contact information:-¶
| Type | Address/Details |
|---|---|
| Discord | Discord |
| IRC | freenode at #linuxserver.io more information at:- IRC |
| Forum | LinuxServer.io forum |
A custom base image built with Ubuntu linux and xrdp
The following line is only in this repo for loop testing:
- { date: "01.01.50:", desc: "I am the release message for this internal repo." }
DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. This base image has been replaced by: https://github.com/linuxserver/docker-baseimage-kasmvnc
Contact information:-¶
| Type | Address/Details |
|---|---|
| Discord | Discord |
| IRC | freenode at #linuxserver.io more information at:- IRC |
| Forum | LinuxServer.io forum |
A custom base image built with Ubuntu linux and xrdp
The following line is only in this repo for loop testing:
- { date: "01.01.50:", desc: "I am the release message for this internal repo." }
DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. We recommend switching to a newer tag
Contact information:-¶
| Type | Address/Details |
|---|---|
| Discord | Discord |
| IRC | freenode at #linuxserver.io more information at:- IRC |
| Forum | LinuxServer.io forum |
A custom base image built with Ubuntu linux and xrdp
The following line is only in this repo for loop testing:
- { date: "01.01.50:", desc: "I am the release message for this internal repo." }
DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. We recommend switching to a newer tag
Contact information:-¶
| Type | Address/Details |
|---|---|
| Discord | Discord |
| IRC | freenode at #linuxserver.io more information at:- IRC |
| Forum | LinuxServer.io forum |
A custom base image built with Ubuntu linux and xrdp
The following line is only in this repo for loop testing:
- { date: "01.01.50:", desc: "I am the release message for this internal repo." }
linuxserver/bazarr¶
Bazarr is a companion application to Sonarr and Radarr. It can manage and download subtitles based on your requirements. You define your preferences by TV show or movie and Bazarr takes care of everything for you.
Supported Architectures¶
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/bazarr:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
| Tag | Available | Description |
|---|---|---|
| latest | ✅ | Stable releases from Bazarr |
| development | ✅ | Pre-releases from Bazarr |
| ## Application Setup |
- Once running the URL will be
http://<host-ip>:6767. - You must complete all the setup parameters in the webui before you can save the config.
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)¶
---
+ bazarr - LinuxServer.io linuxserver/bazarr¶
Bazarr is a companion application to Sonarr and Radarr. It can manage and download subtitles based on your requirements. You define your preferences by TV show or movie and Bazarr takes care of everything for you.
Supported Architectures¶
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/bazarr:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
Tag Available Description latest ✅ Stable releases from Bazarr development ✅ Pre-releases from Bazarr ## Application Setup
- Once running the URL will be
http://<host-ip>:6767. - You must complete all the setup parameters in the webui before you can save the config.
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)¶
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 6767Allows HTTP access to the internal webserver.
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configBazarr data /moviesLocation of your movies /tvLocation of your TV Shows
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:
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:
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 bazarr /bin/bash- To monitor the logs of the container in realtime:
docker logs -f bazarr- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' bazarr- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/bazarr:latest
Versions¶
- 11.08.23: - Rebase to Alpine 3.18.
- 10.08.23: - Bump unrar to 6.2.10.
- 04.07.23: - Deprecate armhf. As announced here
- 26.02.23: - Add dependencies for postgres support. Add mediainfo.
- 23.01.23: - Rebase master branch to Alpine 3.17.
- 11.10.22: - Rebase master branch to Alpine 3.16, migrate to s6v3.
- 15.15.21: - Temp fix for lxml, compile from scratch to avoid broken official wheel.
- 25.10.21: - Rebase to alpine 3.14. Fix numpy wheel.
- 22.10.21: - Added openblas package to prevent numpy error.
- 16.05.21: - Use wheel index.
- 19.04.21: - Install from release zip.
- 07.04.21: - Move app to /app/bazarr/bin, add
package_info. - 23.01.21: - Rebasing to alpine 3.13.
- 23.01.21: - Deprecate
UMASK_SET in favor of UMASK in baseimage, see above for more information. - 01.06.20: - Rebasing to alpine 3.12.
- 13.05.20: - Add donation links for Bazarr to Github sponsors button and container log.
- 08.04.20: - Removed /movies and /tv volumes from Dockerfiles.
- 28.12.19: - Upgrade to Python 3.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 13.06.19: - Add env variable for setting umask.
- 12.06.19: - Swap to install deps using maintainers requirements.txt, add ffmpeg for ffprobe.
- 17.04.19: - Add default UTC timezone if user does not set it.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebasing to alpine 3.9.
- 11.09.18: - Initial release.
\ No newline at end of file
+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 bazarr /bin/bash- To monitor the logs of the container in realtime:
docker logs -f bazarr- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' bazarr- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/bazarr:latest
Versions¶
- 11.08.23: - Rebase to Alpine 3.18.
- 10.08.23: - Bump unrar to 6.2.10.
- 04.07.23: - Deprecate armhf. As announced here
- 26.02.23: - Add dependencies for postgres support. Add mediainfo.
- 23.01.23: - Rebase master branch to Alpine 3.17.
- 11.10.22: - Rebase master branch to Alpine 3.16, migrate to s6v3.
- 15.15.21: - Temp fix for lxml, compile from scratch to avoid broken official wheel.
- 25.10.21: - Rebase to alpine 3.14. Fix numpy wheel.
- 22.10.21: - Added openblas package to prevent numpy error.
- 16.05.21: - Use wheel index.
- 19.04.21: - Install from release zip.
- 07.04.21: - Move app to /app/bazarr/bin, add
package_info. - 23.01.21: - Rebasing to alpine 3.13.
- 23.01.21: - Deprecate
UMASK_SETin favor of UMASK in baseimage, see above for more information. - 01.06.20: - Rebasing to alpine 3.12.
- 13.05.20: - Add donation links for Bazarr to Github sponsors button and container log.
- 08.04.20: - Removed /movies and /tv volumes from Dockerfiles.
- 28.12.19: - Upgrade to Python 3.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 13.06.19: - Add env variable for setting umask.
- 12.06.19: - Swap to install deps using maintainers requirements.txt, add ffmpeg for ffprobe.
- 17.04.19: - Add default UTC timezone if user does not set it.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebasing to alpine 3.9.
- 11.09.18: - Initial release.
linuxserver/beets¶
Beets is a music library manager and not, for the most part, a music player. It does include a simple player plugin and an experimental Web-based player, but it generally leaves actual sound-reproduction to specialized tools.
Supported Architectures¶
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/beets:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
| Tag | Available | Description |
|---|---|---|
| latest | ✅ | Stable Beets Releases |
| nightly | ✅ | Built against head of Beets git, generally considered unstable but a likely choice for power users of the application. |
| ## Application Setup |
Edit the config file in /config
To edit the config from within the container use beet config -e
For a command prompt as user abc docker exec -it -u abc beets bash
See Beets for more info.
Contains beets-extrafiles plugin, configuration details
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)¶
---
+ beets - LinuxServer.io linuxserver/beets¶
Beets is a music library manager and not, for the most part, a music player. It does include a simple player plugin and an experimental Web-based player, but it generally leaves actual sound-reproduction to specialized tools.
Supported Architectures¶
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/beets:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
Tag Available Description latest ✅ Stable Beets Releases nightly ✅ Built against head of Beets git, generally considered unstable but a likely choice for power users of the application. ## Application Setup
Edit the config file in /config
To edit the config from within the container use beet config -e
For a command prompt as user abc docker exec -it -u abc beets bash
See Beets for more info.
Contains beets-extrafiles plugin, configuration details
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)¶
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 8337Application WebUI
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configConfiguration files. /musicMusic library /downloadsNon processed music
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:
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:
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 beets /bin/bash- To monitor the logs of the container in realtime:
docker logs -f beets- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' beets- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/beets:latest
Versions¶
- 25.08.23: - Rebase to Alpine 3.18, pin Pillow to 9.5.0.
- 07.07.23: - Deprecate armhf. As announced here
- 25.03.23: - Add requests_oauthlib required for beatport plugin.
- 24.02.23: - Rebase to Alpine 3.17, migrate to s6v3, install chromaprint from Alpine repos, add beetcamp plugin.
- 15.01.22: - Rebasing to alpine 3.15.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 12.05.19: - Add flac and mp3val binaries required for badfiles plugin.
- 12.04.19: - Rebase to Alpine 3.9.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 11.03.19: - Swap copyartifacts for extrafiles, update endpoints with nightly tag.
- 01.03.19: - Switch to python3.
- 07.02.19: - Add fftw-dev build dependency for chromaprint.
- 28.01.19: - Add pipeline logic and multi arch.
- 15.08.18: - Rebase to alpine 3.8, use alpine repo version of pylast.
- 12.08.18: - Add requests pip package.
- 04.03.18: - Upgrade mp3gain to 1.6.1.
- 02.01.18: - Deprecate cpu_core routine lack of scaling.
- 27.12.17: - Add beautifulsoup4 pip package.
- 06.12.17: - Rebase to alpine linux 3.7.
- 25.05.17: - Rebase to alpine linux 3.6.
- 06.02.17: - Rebase to alpine linux 3.5.
- 16.01.17: - Add packages required for replaygain.
- 24.12.16: - Add beets-copyartifacts plugin.
- 07.12.16: - Edit cmake options for chromaprint, should now build and install fpcalc, add gstreamer lib
- 14.10.16: - Add version layer information.
- 01.10.16: - Add nano and editor variable to allow editing of the config from the container command line.
- 30.09.16: - Fix umask.
- 24.09.16: - Rebase to alpine linux.
- 10.09.16: - Add layer badges to README.
- 05.01.16: - Change ffpmeg repository, other version crashes container
- 06.11.15: - Initial Release
- 29.11.15: - Take out term setting, causing issues with key entry for some users
\ No newline at end of file
+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 beets /bin/bash- To monitor the logs of the container in realtime:
docker logs -f beets- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' beets- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/beets:latest
Versions¶
- 25.08.23: - Rebase to Alpine 3.18, pin Pillow to 9.5.0.
- 07.07.23: - Deprecate armhf. As announced here
- 25.03.23: - Add requests_oauthlib required for beatport plugin.
- 24.02.23: - Rebase to Alpine 3.17, migrate to s6v3, install chromaprint from Alpine repos, add beetcamp plugin.
- 15.01.22: - Rebasing to alpine 3.15.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 12.05.19: - Add flac and mp3val binaries required for badfiles plugin.
- 12.04.19: - Rebase to Alpine 3.9.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 11.03.19: - Swap copyartifacts for extrafiles, update endpoints with nightly tag.
- 01.03.19: - Switch to python3.
- 07.02.19: - Add fftw-dev build dependency for chromaprint.
- 28.01.19: - Add pipeline logic and multi arch.
- 15.08.18: - Rebase to alpine 3.8, use alpine repo version of pylast.
- 12.08.18: - Add requests pip package.
- 04.03.18: - Upgrade mp3gain to 1.6.1.
- 02.01.18: - Deprecate cpu_core routine lack of scaling.
- 27.12.17: - Add beautifulsoup4 pip package.
- 06.12.17: - Rebase to alpine linux 3.7.
- 25.05.17: - Rebase to alpine linux 3.6.
- 06.02.17: - Rebase to alpine linux 3.5.
- 16.01.17: - Add packages required for replaygain.
- 24.12.16: - Add beets-copyartifacts plugin.
- 07.12.16: - Edit cmake options for chromaprint, should now build and install fpcalc, add gstreamer lib
- 14.10.16: - Add version layer information.
- 01.10.16: - Add nano and editor variable to allow editing of the config from the container command line.
- 30.09.16: - Fix umask.
- 24.09.16: - Rebase to alpine linux.
- 10.09.16: - Add layer badges to README.
- 05.01.16: - Change ffpmeg repository, other version crashes container
- 06.11.15: - Initial Release
- 29.11.15: - Take out term setting, causing issues with key entry for some users
linuxserver/blender¶
Blender is a free and open-source 3D computer graphics software toolset used for creating animated films, visual effects, art, 3D printed models, motion graphics, interactive 3D applications, virtual reality, and computer games. This image does not support GPU rendering out of the box only accelerated workspace experience
Supported Architectures¶
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/blender:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
The application can be accessed at:
- http://yourhost:3000/
- https://yourhost:3001/
Hardware Acceleration¶
This only applies to your desktop experience, this container is capable of supporting accelerated rendering with /dev/dri mounted in, but the AMD HIP and Nvidia CUDA runtimes are massive which are not installed by default in this container.
Intel/ATI/AMD¶
To leverage hardware acceleration you will need to mount /dev/dri video device inside of the conainer.
--device /dev/dri:/dev/dri
+ blender - LinuxServer.io linuxserver/blender¶
Blender is a free and open-source 3D computer graphics software toolset used for creating animated films, visual effects, art, 3D printed models, motion graphics, interactive 3D applications, virtual reality, and computer games. This image does not support GPU rendering out of the box only accelerated workspace experience
Supported Architectures¶
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/blender:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
The application can be accessed at:
- http://yourhost:3000/
- https://yourhost:3001/
Hardware Acceleration¶
This only applies to your desktop experience, this container is capable of supporting accelerated rendering with /dev/dri mounted in, but the AMD HIP and Nvidia CUDA runtimes are massive which are not installed by default in this container.
Intel/ATI/AMD¶
To leverage hardware acceleration you will need to mount /dev/dri video device inside of the conainer.
We will automatically ensure the abc user inside of the container has the proper permissions to access this device. Nvidia¶
Hardware acceleration users for Nvidia will need to install the container runtime provided by Nvidia on their host, instructions can be found here: https://github.com/NVIDIA/nvidia-docker
We automatically add the necessary environment variable that will utilise all the features available on a GPU on the host. Once nvidia-docker is installed on your host you will need to re/create the docker container with the nvidia container runtime --runtime=nvidia and add an environment variable -e NVIDIA_VISIBLE_DEVICES=all (can also be set to a specific gpu's UUID, this can be discovered by running nvidia-smi --query-gpu=gpu_name,gpu_uuid --format=csv ). NVIDIA automatically mounts the GPU and drivers from your host into the container.
Arm Devices¶
Arm devices can run this image, but generally should not mount in /dev/dri. The OpenGL ES version is not high enough to run Blender. The program can run on these platforms though, leveraging CPU LLVMPipe rendering.
Due to lack of arm64 binaries from the upstream project, our arm64 image installs the latest version from the ubuntu repo, which is usually behind and thus the version the image is tagged with does not match the version contained.
Options in all KasmVNC based GUI containers¶
This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.
Optional environment variables¶
Variable Description CUSTOM_PORT Internal port the container listens on for http if it needs to be swapped from the default 3000. CUSTOM_HTTPS_PORT Internal port the container listens on for https if it needs to be swapped from the default 3001. CUSTOM_USER HTTP Basic auth username, abc is default. PASSWORD HTTP Basic auth password, abc is default. If unset there will be no auth SUBFOLDER Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/ TITLE The page title displayed on the web browser, default "KasmVNC Client". FM_HOME This is the home directory (landing) for the file manager, default "/config". START_DOCKER If set to false a container with privilege will not automatically start the DinD Docker setup. DRINODE If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE /dev/dri/renderD128
Optional run configurations¶
Variable Description --privilegedWill start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE -v /home/user/docker-data:/var/lib/docker. -v /var/run/docker.sock:/var/run/docker.sockMount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. --device /dev/dri:/dev/driMount a GPU into the container, this can be used in conjunction with the DRINODE environment variable to leverage a host video card for GPU accelerated appplications. Only Open Source drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau)
Lossless mode¶
This container is capable of delivering a true lossless image at a high framerate to your web browser by changing the Stream Quality preset to "Lossless", more information here. In order to use this mode from a non localhost endpoint the HTTPS port on 3001 needs to be used. If using a reverse proxy to port 3000 specific headers will need to be set as outlined here.
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)¶
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 3000Blender desktop gui 3001Blender desktop gui HTTPS
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. SUBFOLDER=/Specify a subfolder to use with reverse proxies, IE /subfolder/
Volume Mappings (-v)¶
Volume Function /configUsers home directory in the container, stores local files and settings
Miscellaneous Options¶
Parameter Function --security-opt seccomp=unconfinedFor Docker Engine only, this may be required depending on your Docker and storage configuration.
Environment variables from files (Docker secrets)¶
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
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:
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 blender /bin/bash- To monitor the logs of the container in realtime:
docker logs -f blender- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' blender- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/blender:latest
Versions¶
- 18.03.23: - Rebase to KasmVNC base image.
- 13.12.22: - Rebase to Jammy, migrate to s6v3.
- 06.05.22: - Use the full semver version in image tags. Arm32/64 version tags are inaccurate due to installing from ubuntu repo, which is usually behind.
- 12.03.22: - Initial Release.
\ No newline at end of file
+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 blender /bin/bash- To monitor the logs of the container in realtime:
docker logs -f blender- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' blender- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/blender:latest
Versions¶
- 18.03.23: - Rebase to KasmVNC base image.
- 13.12.22: - Rebase to Jammy, migrate to s6v3.
- 06.05.22: - Use the full semver version in image tags. Arm32/64 version tags are inaccurate due to installing from ubuntu repo, which is usually behind.
- 12.03.22: - Initial Release.
linuxserver/boinc¶
BOINC is a platform for high-throughput computing on a large scale (thousands or millions of computers). It can be used for volunteer computing (using consumer devices) or grid computing (using organizational resources). It supports virtualized, parallel, and GPU-based applications.
Supported Architectures¶
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/boinc:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
This image sets up the BOINC client and manager and makes its interface available via Guacamole server in the browser. The interface is available at http://your-ip:8080 or https://your-ip:8181.
By default, there is no password set for the main gui. Optional environment variable PASSWORD will allow setting a password for the user abc.
It is recommended to switch to Advanced View in the top menu, because the Computing Preferences don't seem to be displayed in Simple View.
Sometimes, the pop-up windows may open in a tiny box in the upper left corner of the screen. When that happens, you can find the corner and resize them.
GPU Hardware Acceleration¶
Intel¶
Hardware acceleration users for Intel Quicksync will need to mount their /dev/dri video device inside of the container by passing the following command when running or creating the container: --device=/dev/dri:/dev/dri We will automatically ensure the abc user inside of the container has the proper permissions to access this device.
Nvidia¶
Hardware acceleration users for Nvidia will need to install the container runtime provided by Nvidia on their host, instructions can be found here: https://github.com/NVIDIA/nvidia-docker We automatically add the necessary environment variable that will utilise all the features available on a GPU on the host. Once nvidia-docker is installed on your host you will need to re/create the docker container with the nvidia container runtime --runtime=nvidia and add an environment variable -e NVIDIA_VISIBLE_DEVICES=all (can also be set to a specific gpu's UUID, this can be discovered by running nvidia-smi --query-gpu=gpu_name,gpu_uuid --format=csv ). NVIDIA automatically mounts the GPU and drivers from your host into the BOINC docker container.
Options in all KasmVNC based GUI containers¶
This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.
Optional environment variables¶
| Variable | Description |
|---|---|
| CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default 8080. |
| CUSTOM_HTTPS_PORT | Internal port the container listens on for https if it needs to be swapped from the default 8181. |
| CUSTOM_USER | HTTP Basic auth username, abc is default. |
| PASSWORD | HTTP Basic auth password, abc is default. If unset there will be no auth |
| SUBFOLDER | Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/ |
| TITLE | The page title displayed on the web browser, default "KasmVNC Client". |
| FM_HOME | This is the home directory (landing) for the file manager, default "/config". |
| START_DOCKER | If set to false a container with privilege will not automatically start the DinD Docker setup. |
| DRINODE | If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE /dev/dri/renderD128 |
Optional run configurations¶
| Variable | Description |
|---|---|
--privileged | Will start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE -v /home/user/docker-data:/var/lib/docker. |
-v /var/run/docker.sock:/var/run/docker.sock | Mount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. |
--device /dev/dri:/dev/dri | Mount a GPU into the container, this can be used in conjunction with the DRINODE environment variable to leverage a host video card for GPU accelerated appplications. Only Open Source drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau) |
Lossless mode¶
This container is capable of delivering a true lossless image at a high framerate to your web browser by changing the Stream Quality preset to "Lossless", more information here. In order to use this mode from a non localhost endpoint the HTTPS port on 8181 needs to be used. If using a reverse proxy to port 8080 specific headers will need to be set as outlined here.
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)¶
---
+ boinc - LinuxServer.io linuxserver/boinc¶
BOINC is a platform for high-throughput computing on a large scale (thousands or millions of computers). It can be used for volunteer computing (using consumer devices) or grid computing (using organizational resources). It supports virtualized, parallel, and GPU-based applications.
Supported Architectures¶
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/boinc:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
This image sets up the BOINC client and manager and makes its interface available via Guacamole server in the browser. The interface is available at http://your-ip:8080 or https://your-ip:8181.
By default, there is no password set for the main gui. Optional environment variable PASSWORD will allow setting a password for the user abc.
It is recommended to switch to Advanced View in the top menu, because the Computing Preferences don't seem to be displayed in Simple View.
Sometimes, the pop-up windows may open in a tiny box in the upper left corner of the screen. When that happens, you can find the corner and resize them.
GPU Hardware Acceleration¶
Intel¶
Hardware acceleration users for Intel Quicksync will need to mount their /dev/dri video device inside of the container by passing the following command when running or creating the container: --device=/dev/dri:/dev/dri We will automatically ensure the abc user inside of the container has the proper permissions to access this device.
Nvidia¶
Hardware acceleration users for Nvidia will need to install the container runtime provided by Nvidia on their host, instructions can be found here: https://github.com/NVIDIA/nvidia-docker We automatically add the necessary environment variable that will utilise all the features available on a GPU on the host. Once nvidia-docker is installed on your host you will need to re/create the docker container with the nvidia container runtime --runtime=nvidia and add an environment variable -e NVIDIA_VISIBLE_DEVICES=all (can also be set to a specific gpu's UUID, this can be discovered by running nvidia-smi --query-gpu=gpu_name,gpu_uuid --format=csv ). NVIDIA automatically mounts the GPU and drivers from your host into the BOINC docker container.
Options in all KasmVNC based GUI containers¶
This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.
Optional environment variables¶
Variable Description CUSTOM_PORT Internal port the container listens on for http if it needs to be swapped from the default 8080. CUSTOM_HTTPS_PORT Internal port the container listens on for https if it needs to be swapped from the default 8181. CUSTOM_USER HTTP Basic auth username, abc is default. PASSWORD HTTP Basic auth password, abc is default. If unset there will be no auth SUBFOLDER Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/ TITLE The page title displayed on the web browser, default "KasmVNC Client". FM_HOME This is the home directory (landing) for the file manager, default "/config". START_DOCKER If set to false a container with privilege will not automatically start the DinD Docker setup. DRINODE If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE /dev/dri/renderD128
Optional run configurations¶
Variable Description --privilegedWill start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE -v /home/user/docker-data:/var/lib/docker. -v /var/run/docker.sock:/var/run/docker.sockMount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. --device /dev/dri:/dev/driMount a GPU into the container, this can be used in conjunction with the DRINODE environment variable to leverage a host video card for GPU accelerated appplications. Only Open Source drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau)
Lossless mode¶
This container is capable of delivering a true lossless image at a high framerate to your web browser by changing the Stream Quality preset to "Lossless", more information here. In order to use this mode from a non localhost endpoint the HTTPS port on 8181 needs to be used. If using a reverse proxy to port 8080 specific headers will need to be set as outlined here.
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)¶
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 8080Boinc desktop gui. 8181Boinc desktop gui HTTPS.
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. PASSWORD=Optionally set a password for the gui.
Volume Mappings (-v)¶
Volume Function /configWhere BOINC should store its database and config.
Device Mappings (--device)¶
Parameter Function /dev/driOnly needed if you want to use your Intel GPU (vaapi).
Miscellaneous Options¶
Parameter Function --security-opt seccomp=unconfinedFor Docker Engine only, many modern gui apps need this to function as syscalls are unkown to Docker.
Environment variables from files (Docker secrets)¶
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
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:
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 boinc /bin/bash- To monitor the logs of the container in realtime:
docker logs -f boinc- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' boinc- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/boinc:latest
Versions¶
- 03.04.23: - Rebase to KasmVNC base image. Deprecate armhf build as the new base does not support it. Add bzip2 and xz-utils.
- 14.11.22: - Fix opencl driver.
- 18.09.22: - Rebase to jammy.
- 24.02.22: - Rebase to focal.
- 31.01.22: - Improve device permissions setting verbosity.
- 23.03.21: - Rebase to rdesktop-web baseimage. Deprecate
GUAC_USER and GUAC_PASS env vars. Existing users can set the new var PASSWORD for the user abc. - 01.04.20: - Install boinc from ppa.
- 17.03.20: - Add armhf and aarch64 builds and switch to multi-arch image.
- 16.03.20: - Clean up old pid files.
- 15.03.20: - Initial release.
\ No newline at end of file
+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 boinc /bin/bash- To monitor the logs of the container in realtime:
docker logs -f boinc- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' boinc- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/boinc:latest
Versions¶
- 03.04.23: - Rebase to KasmVNC base image. Deprecate armhf build as the new base does not support it. Add bzip2 and xz-utils.
- 14.11.22: - Fix opencl driver.
- 18.09.22: - Rebase to jammy.
- 24.02.22: - Rebase to focal.
- 31.01.22: - Improve device permissions setting verbosity.
- 23.03.21: - Rebase to rdesktop-web baseimage. Deprecate
GUAC_USERandGUAC_PASSenv vars. Existing users can set the new varPASSWORDfor the userabc. - 01.04.20: - Install boinc from ppa.
- 17.03.20: - Add armhf and aarch64 builds and switch to multi-arch image.
- 16.03.20: - Clean up old pid files.
- 15.03.20: - Initial release.
linuxserver/booksonic-air¶
Booksonic-air is a platform for accessing the audiobooks you own wherever you are. At the moment the platform consists of: * Booksonic Air - A server for streaming your audiobooks, successor to the original Booksonic server and based on Airsonic. * Booksonic App - An DSub based Android app for connection to Booksonic-Air servers.
Supported Architectures¶
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/booksonic-air:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
Whilst this is a more up to date rebase of the original Booksonic server, upgrading in place is not supported and a fresh install has been recommended. Default user/pass is admin/admin
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)¶
---
+ booksonic-air - LinuxServer.io linuxserver/booksonic-air¶
Booksonic-air is a platform for accessing the audiobooks you own wherever you are. At the moment the platform consists of: * Booksonic Air - A server for streaming your audiobooks, successor to the original Booksonic server and based on Airsonic. * Booksonic App - An DSub based Android app for connection to Booksonic-Air servers.
Supported Architectures¶
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/booksonic-air:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
Whilst this is a more up to date rebase of the original Booksonic server, upgrading in place is not supported and a fresh install has been recommended. Default user/pass is admin/admin
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)¶
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 4040Application WebUI
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. CONTEXT_PATH=url-baseBase url for use with reverse proxies etc.
Volume Mappings (-v)¶
Volume Function /configConfiguration files. /audiobooksAudiobooks. /podcastsPodcasts. /othermediaOther media.
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:
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:
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 booksonic-air /bin/bash- To monitor the logs of the container in realtime:
docker logs -f booksonic-air- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' booksonic-air- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/booksonic-air:latest
Versions¶
- 10.07.23: - Rebase to Alpine 3.18.
- 25.12.22: - Rebase to Alpine 3.17, migrate to s6v3, bump jre to 11, deprecate armhf.
- 18.04.22: - Rebase to Alpine 3.15.
- 15.09.20: - Initial Release.
\ No newline at end of file
+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 booksonic-air /bin/bash- To monitor the logs of the container in realtime:
docker logs -f booksonic-air- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' booksonic-air- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/booksonic-air:latest
Versions¶
- 10.07.23: - Rebase to Alpine 3.18.
- 25.12.22: - Rebase to Alpine 3.17, migrate to s6v3, bump jre to 11, deprecate armhf.
- 18.04.22: - Rebase to Alpine 3.15.
- 15.09.20: - Initial Release.
DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. Please migrate to https://github.com/linuxserver/docker-booksonic-air
linuxserver/booksonic¶
Booksonic is a server and an app for streaming your audiobooks to any pc or android phone. Most of the functionality is also availiable on other platforms that have apps for subsonic.
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/booksonic 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 | amd64-latest |
| arm64 | arm64v8-latest |
| armhf | arm32v7-latest |
Version Tags¶
This image provides various versions that are available via tags. latest tag usually provides the latest stable version. Others are considered under development and caution must be exercised when using them.
| Tag | Description |
|---|---|
| latest | Stable Booksonic releases |
| prerelease | Booksonic Pre-releases |
Application Setup¶
Default user/pass is admin/admin
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)¶
---
+ booksonic - LinuxServer.io DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. Please migrate to https://github.com/linuxserver/docker-booksonic-air
linuxserver/booksonic¶
Booksonic is a server and an app for streaming your audiobooks to any pc or android phone. Most of the functionality is also availiable on other platforms that have apps for subsonic.
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/booksonic 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 amd64-latest arm64 arm64v8-latest armhf arm32v7-latest
Version Tags¶
This image provides various versions that are available via tags. latest tag usually provides the latest stable version. Others are considered under development and caution must be exercised when using them.
Tag Description latest Stable Booksonic releases prerelease Booksonic Pre-releases
Application Setup¶
Default user/pass is admin/admin
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)¶
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 4040Application WebUI
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Europe/LondonSpecify a timezone to use EG Europe/London. CONTEXT_PATH=url-baseBase url for use with reverse proxies etc.
Volume Mappings (-v)¶
Volume Function /configConfiguration files. /audiobooksAudiobooks. /podcastsPodcasts. /othermediaOther media.
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:
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:
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 booksonic /bin/bash- To monitor the logs of the container in realtime:
docker logs -f booksonic- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' booksonic- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/booksonic
Versions¶
- 06.05.21: - This image is now deprecated. Please migrate to https://github.com/linuxserver/docker-booksonic-air
- 11.08.20: - Changed upstream github repo location
- 22.12.19: - Revert to pulling in external war, upgrade jetty.
- 30.04.19: - Switching to build war from source, use stable booksonic releases.
- 24.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 16.01.19: - Adding pipeline logic and multi arch.
- 05.01.19: - Linting fixes.
- 27.08.18: - Rebase to ubuntu bionic.
- 06.12.17: - Rebase to alpine 3.7.
- 11.07.17: - Rebase to alpine 3.6.
- 07.02.17: - Rebase to alpine 3.5.
- 13.12.16: - Initial Release.
\ No newline at end of file
+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 booksonic /bin/bash- To monitor the logs of the container in realtime:
docker logs -f booksonic- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' booksonic- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/booksonic
Versions¶
- 06.05.21: - This image is now deprecated. Please migrate to https://github.com/linuxserver/docker-booksonic-air
- 11.08.20: - Changed upstream github repo location
- 22.12.19: - Revert to pulling in external war, upgrade jetty.
- 30.04.19: - Switching to build war from source, use stable booksonic releases.
- 24.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 16.01.19: - Adding pipeline logic and multi arch.
- 05.01.19: - Linting fixes.
- 27.08.18: - Rebase to ubuntu bionic.
- 06.12.17: - Rebase to alpine 3.7.
- 11.07.17: - Rebase to alpine 3.6.
- 07.02.17: - Rebase to alpine 3.5.
- 13.12.16: - Initial Release.
linuxserver/bookstack¶
Bookstack is a free and open source Wiki designed for creating beautiful documentation. Featuring a simple, but powerful WYSIWYG editor it allows for teams to create detailed and useful documentation with ease.
Powered by SQL and including a Markdown editor for those who prefer it, BookStack is geared towards making documentation more of a pleasure than a chore.
For more information on BookStack visit their website and check it out: https://www.bookstackapp.com
Supported Architectures¶
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/bookstack:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
The default username is admin@admin.com with the password of password, access the container at http://dockerhost:6875.
This application is dependent on a MySQL database be it one you already have or a new one. If you do not already have one, set up our MariaDB container here https://hub.docker.com/r/linuxserver/mariadb/.
If you intend to use this application behind a subfolder reverse proxy, such as our SWAG container or Traefik you will need to make sure that the APP_URL environment variable is set to your external domain, or it will not work.
Documentation for BookStack can be found at https://www.bookstackapp.com/docs/.
BookStack File & Directory Paths¶
This container ensures certain BookStack application files & folders, such as user file upload folders, are retained within the /config folder so that they are persistent & accessible when the /config container path is bound as a volume. There may be cases, when following the BookStack documentation, that you'll need to know how these files and folders are used relative to a non-container BookStack installation.
Below is a mapping of container /config paths to those relative within a BookStack install directory:
- /config container path => BookStack relative path
/config/www/.env=>.env/config/www/laravel.log=>storage/logs/laravel.log/config/www/backups/=>storage/backups//config/www/files/=>storage/uploads/files//config/www/images/=>storage/uploads/images//config/www/themes/=>themes//config/www/uploads/=>public/uploads/
Advanced Users (full control over the .env file)¶
If you wish to use the extra functionality of BookStack such as email, Memcache, LDAP and so on you will need to make your own .env file with guidance from the BookStack documentation.
When you create the container, do not set any arguments for any SQL settings. The container will copy an exemplary .env file to /config/www/.env on your host system for you to edit.
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)¶
---
+ bookstack - LinuxServer.io linuxserver/bookstack¶
Bookstack is a free and open source Wiki designed for creating beautiful documentation. Featuring a simple, but powerful WYSIWYG editor it allows for teams to create detailed and useful documentation with ease.
Powered by SQL and including a Markdown editor for those who prefer it, BookStack is geared towards making documentation more of a pleasure than a chore.
For more information on BookStack visit their website and check it out: https://www.bookstackapp.com
Supported Architectures¶
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/bookstack:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
The default username is admin@admin.com with the password of password, access the container at http://dockerhost:6875.
This application is dependent on a MySQL database be it one you already have or a new one. If you do not already have one, set up our MariaDB container here https://hub.docker.com/r/linuxserver/mariadb/.
If you intend to use this application behind a subfolder reverse proxy, such as our SWAG container or Traefik you will need to make sure that the APP_URL environment variable is set to your external domain, or it will not work.
Documentation for BookStack can be found at https://www.bookstackapp.com/docs/.
BookStack File & Directory Paths¶
This container ensures certain BookStack application files & folders, such as user file upload folders, are retained within the /config folder so that they are persistent & accessible when the /config container path is bound as a volume. There may be cases, when following the BookStack documentation, that you'll need to know how these files and folders are used relative to a non-container BookStack installation.
Below is a mapping of container /config paths to those relative within a BookStack install directory:
- /config container path => BookStack relative path
/config/www/.env => .env/config/www/laravel.log => storage/logs/laravel.log/config/www/backups/ => storage/backups//config/www/files/ => storage/uploads/files//config/www/images/ => storage/uploads/images//config/www/themes/ => themes//config/www/uploads/ => public/uploads/
Advanced Users (full control over the .env file)¶
If you wish to use the extra functionality of BookStack such as email, Memcache, LDAP and so on you will need to make your own .env file with guidance from the BookStack documentation.
When you create the container, do not set any arguments for any SQL settings. The container will copy an exemplary .env file to /config/www/.env on your host system for you to edit.
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)¶
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 80will map the container's port 80 to port 6875 on the host
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. APP_URL=<yourbaseurl>for specifying the IP:port or URL your application will be accessed on (ie. http://192.168.1.1:6875 or https://bookstack.mydomain.com DB_HOST=<yourdbhost>for specifying the database host DB_PORT=<yourdbport>for specifying the database port if not default 3306 DB_USER=<yourdbuser>for specifying the database user DB_PASS=<yourdbpass>for specifying the database password (minimum 4 characters & non-alphanumeric passwords must be properly escaped.) DB_DATABASE=bookstackappfor specifying the database to be used
Volume Mappings (-v)¶
Volume Function /configthis will store any uploaded data on the docker host
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:
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:
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 bookstack /bin/bash- To monitor the logs of the container in realtime:
docker logs -f bookstack- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' bookstack- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/bookstack:latest
Versions¶
- 07.06.23: - Add mariadb-client for bookstack-system-cli support.
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 13.04.23: - Move ssl.conf include to default.conf.
- 01.03.23: - Add php iconv.
- 19.01.23: - Rebase to alpine 3.17 with php8.1.
- 16.01.23: - Wrap
.env values in quotes. - 05.01.23: - Fix db password setting (sed escape
&). - 21.12.22: - Update db info in .env file when env vars are updated.
- 10.10.22: - Remove password escape logic which caused problems for a small subset of users.
- 20.08.22: - Rebasing to alpine 3.15 with php8. Restructure nginx configs (see changes announcement).
- 14.03.22: - Add symlinks for theme support.
- 11.07.21: - Rebase to Alpine 3.14.
- 12.01.21: - Remove unused requirement, as of release 0.31.0.
- 17.12.20: - Make APP_URL var required (upstream changes).
- 17.09.20: - Rebase to alpine 3.12. Fix APP_URL setting. Bump php post max and upload max filesizes to 100MB by default.
- 19.12.19: - Rebasing to alpine 3.11.
- 26.07.19: - Use old version of tidyhtml pending upstream fixes.
- 28.06.19: - Rebasing to alpine 3.10.
- 14.06.19: - Add wkhtmltopdf to image for PDF rendering.
- 20.04.19: - Rebase to Alpine 3.9, add MySQL init logic.
- 22.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 20.01.19: - Added php7-curl
- 04.11.18: - Added php7-ldap
- 15.10.18: - Changed functionality for advanced users
- 08.10.18: - Advanced mode, symlink changes, sed fixing, docs updated, added some composer files
- 23.09.28: - Updates pre-release
- 02.07.18: - Initial Release.
\ No newline at end of file
+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 bookstack /bin/bash- To monitor the logs of the container in realtime:
docker logs -f bookstack- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' bookstack- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/bookstack:latest
Versions¶
- 07.06.23: - Add mariadb-client for bookstack-system-cli support.
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 13.04.23: - Move ssl.conf include to default.conf.
- 01.03.23: - Add php iconv.
- 19.01.23: - Rebase to alpine 3.17 with php8.1.
- 16.01.23: - Wrap
.envvalues in quotes. - 05.01.23: - Fix db password setting (sed escape
&). - 21.12.22: - Update db info in .env file when env vars are updated.
- 10.10.22: - Remove password escape logic which caused problems for a small subset of users.
- 20.08.22: - Rebasing to alpine 3.15 with php8. Restructure nginx configs (see changes announcement).
- 14.03.22: - Add symlinks for theme support.
- 11.07.21: - Rebase to Alpine 3.14.
- 12.01.21: - Remove unused requirement, as of release 0.31.0.
- 17.12.20: - Make APP_URL var required (upstream changes).
- 17.09.20: - Rebase to alpine 3.12. Fix APP_URL setting. Bump php post max and upload max filesizes to 100MB by default.
- 19.12.19: - Rebasing to alpine 3.11.
- 26.07.19: - Use old version of tidyhtml pending upstream fixes.
- 28.06.19: - Rebasing to alpine 3.10.
- 14.06.19: - Add wkhtmltopdf to image for PDF rendering.
- 20.04.19: - Rebase to Alpine 3.9, add MySQL init logic.
- 22.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 20.01.19: - Added php7-curl
- 04.11.18: - Added php7-ldap
- 15.10.18: - Changed functionality for advanced users
- 08.10.18: - Advanced mode, symlink changes, sed fixing, docs updated, added some composer files
- 23.09.28: - Updates pre-release
- 02.07.18: - Initial Release.
linuxserver/budge¶
budge is an open source 'budgeting with envelopes' personal finance app.
Supported Architectures¶
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/budge:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
Access the web gui at http://SERVERIP:PORT
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)¶
---
+ budge - LinuxServer.io linuxserver/budge¶
budge is an open source 'budgeting with envelopes' personal finance app.
Supported Architectures¶
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/budge:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
Access the web gui at http://SERVERIP:PORT
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)¶
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 80http gui 443https gui
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configPersistent config files
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:
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:
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 budge /bin/bash- To monitor the logs of the container in realtime:
docker logs -f budge- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' budge- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/budge:latest
Versions¶
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 13.04.23: - Move ssl.conf include to default.conf.
- 29.11.22: - Rebase to Alpine 3.17, migrate to s6v3.
- 04.15.22: - Added NPM command to run db migrations.
- 02.05.22: - Initial Release.
\ No newline at end of file
+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 budge /bin/bash- To monitor the logs of the container in realtime:
docker logs -f budge- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' budge- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/budge:latest
Versions¶
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 13.04.23: - Move ssl.conf include to default.conf.
- 29.11.22: - Rebase to Alpine 3.17, migrate to s6v3.
- 04.15.22: - Added NPM command to run db migrations.
- 02.05.22: - Initial Release.
linuxserver/build-agent¶
Used as part of the LSIO build process. Not for public consumption.
Running¶
services:
+ build-agent - LinuxServer.io linuxserver/build-agent¶
Used as part of the LSIO build process. Not for public consumption.
Running¶
services:
build-agent:
image: lscr.io/linuxserver/build-agent:latest
privileged: true
@@ -13,4 +13,4 @@
ports:
- 2222:2222
restart: unless-stopped
-
For x86_64 machines, run docker run --rm --privileged multiarch/qemu-user-static --reset -p yes on the host to enable qemu before bringing any build agent containers up.
- { date: "30.04.23:", desc: "Initial Release." }
\ No newline at end of file
+For x86_64 machines, run docker run --rm --privileged multiarch/qemu-user-static --reset -p yes on the host to enable qemu before bringing any build agent containers up.
- { date: "30.04.23:", desc: "Initial Release." }
linuxserver/calibre-web¶
Calibre-web is a web app providing a clean interface for browsing, reading and downloading eBooks using an existing Calibre database. It is also possible to integrate google drive and edit metadata and your calibre library through the app itself.
This software is a fork of library and licensed under the GPL v3 License.
Supported Architectures¶
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/calibre-web:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
| Tag | Available | Description |
|---|---|---|
| latest | ✅ | Releases of Calibre-Web |
| nightly | ✅ | Commits to the master branch of Calibre-Web |
| ## Application Setup |
Webui can be found at http://your-ip:8083
On the initial setup screen, enter /books as your calibre library location.
Default admin login: Username: admin Password: admin123
If you lock yourself out or forget a password, you will need to specify the app.db similar to this: docker exec -it calibre-web python3 /app/calibre-web/cps.py -p /config/app.db -s <user>:<pass> If you fail to specify the proper db, it will appear to succeed, but it will not work.
Unrar is included by default and needs to be set in the Calibre-Web admin page (Basic Configuration:External Binaries) with a path of /usr/bin/unrar
64bit only We have implemented the optional ability to pull in the dependencies to enable ebook conversion utilising Calibre, this means if you don't require this feature the container isn't uneccessarily bloated but should you require it, it is easily available. This optional layer will be rebuilt automatically on our CI pipeline upon new Calibre releases so you can stay up to date. To use this option add the optional environmental variable as shown in the docker-mods section to pull an addition docker layer to enable ebook conversion and then in the Calibre-Web admin page (Basic Configuration:External Binaries) set the Path to Calibre E-Book Converter to /usr/bin/ebook-convert
This image contains the kepubify ebook conversion tool (MIT License) to convert epub to kepub. In the Calibre-Web admin page (Basic Configuration:External Binaries) set the Path to Kepubify E-Book Converter to /usr/bin/kepubify
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)¶
---
+ calibre-web - LinuxServer.io linuxserver/calibre-web¶
Calibre-web is a web app providing a clean interface for browsing, reading and downloading eBooks using an existing Calibre database. It is also possible to integrate google drive and edit metadata and your calibre library through the app itself.
This software is a fork of library and licensed under the GPL v3 License.
Supported Architectures¶
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/calibre-web:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
Tag Available Description latest ✅ Releases of Calibre-Web nightly ✅ Commits to the master branch of Calibre-Web ## Application Setup
Webui can be found at http://your-ip:8083
On the initial setup screen, enter /books as your calibre library location.
Default admin login: Username: admin Password: admin123
If you lock yourself out or forget a password, you will need to specify the app.db similar to this: docker exec -it calibre-web python3 /app/calibre-web/cps.py -p /config/app.db -s <user>:<pass> If you fail to specify the proper db, it will appear to succeed, but it will not work.
Unrar is included by default and needs to be set in the Calibre-Web admin page (Basic Configuration:External Binaries) with a path of /usr/bin/unrar
64bit only We have implemented the optional ability to pull in the dependencies to enable ebook conversion utilising Calibre, this means if you don't require this feature the container isn't uneccessarily bloated but should you require it, it is easily available. This optional layer will be rebuilt automatically on our CI pipeline upon new Calibre releases so you can stay up to date. To use this option add the optional environmental variable as shown in the docker-mods section to pull an addition docker layer to enable ebook conversion and then in the Calibre-Web admin page (Basic Configuration:External Binaries) set the Path to Calibre E-Book Converter to /usr/bin/ebook-convert
This image contains the kepubify ebook conversion tool (MIT License) to convert epub to kepub. In the Calibre-Web admin page (Basic Configuration:External Binaries) set the Path to Kepubify E-Book Converter to /usr/bin/kepubify
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)¶
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 8083WebUI
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. DOCKER_MODS=linuxserver/mods:universal-calibre#optional & x86-64 only Adds the ability to perform ebook conversion OAUTHLIB_RELAX_TOKEN_SCOPE=1Optionally set this to allow Google OAUTH to work
Volume Mappings (-v)¶
Volume Function /configWhere calibre-web stores the internal database and config. /booksWhere your preexisting calibre database is located.
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:
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:
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 calibre-web /bin/bash- To monitor the logs of the container in realtime:
docker logs -f calibre-web- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' calibre-web- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/calibre-web:latest
Versions¶
- 13.04.23: - Deprecate armhf.
- 27.03.23: - Add cmake as build dep for Levenshtein.
- 27.12.22: - Add ghostscript, libxtst6, libxkbfile-dev.
- 20.12.22: - Improve init script and prevent harmless error.
- 19.10.22: - Rebase to jammy. Upgrade to s6v3. Clean up build dependencies.
- 04.11.21: - Update pip arguments to ignore distro installed packages.
- 24.06.21: - Add note on optional OAUTHLIB_RELAX_TOKEN_SCOPE for Google OAUTH support.
- 17.05.21: - Add linuxserver wheel index.
- 10.02.21: - Add libxrandr2
- 25.01.21: - Add nightly tag
- 19.01.21: - Add python3-pkg-resources
- 13.01.21: - Rebase to Ubuntu Focal, see here for troubleshooting armhf.
- 12.10.20: - Add libxi6
- 12.07.20: - Add kepubify for arm64v8
- 05.06.20: - Add kepubify for x86-64 and arm32v7
- 06.05.20: - Add libxslt1.1 and update ImageMagick policy
- 19.01.20: - Adding LDAP libs.
- 13.10.19: - Migrate to Python3.
- 01.08.19: - Add libxcomposite1.
- 13.06.19: - Add docker mod to enable optional ebook conversion on x86-64. Add unrar.
- 02.06.19: - Rebase to Ubuntu Bionic & add Gdrive support.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 23.02.19: - Rebase to alpine 3.9, use repo version of imagemagick.
- 11.02.19: - Add pipeline logic and multi arch.
- 03.01.19: - Remove guest user from default app.db.
- 16.08.18: - Rebase to alpine 3.8.
- 03.07.18: - New build pushed, all versions below
67 have vulnerability. - 05.01.18: - Deprecate cpu_core routine lack of scaling.
- 06.12.17: - Rebase to alpine 3.7.
- 27.11.17: - Use cpu core counting routine to speed up build time.
- 24.07.17: - Curl version for imagemagick.
- 17.07.17: - Initial release.
\ No newline at end of file
+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 calibre-web /bin/bash- To monitor the logs of the container in realtime:
docker logs -f calibre-web- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' calibre-web- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/calibre-web:latest
Versions¶
- 13.04.23: - Deprecate armhf.
- 27.03.23: - Add cmake as build dep for Levenshtein.
- 27.12.22: - Add ghostscript, libxtst6, libxkbfile-dev.
- 20.12.22: - Improve init script and prevent harmless error.
- 19.10.22: - Rebase to jammy. Upgrade to s6v3. Clean up build dependencies.
- 04.11.21: - Update pip arguments to ignore distro installed packages.
- 24.06.21: - Add note on optional OAUTHLIB_RELAX_TOKEN_SCOPE for Google OAUTH support.
- 17.05.21: - Add linuxserver wheel index.
- 10.02.21: - Add libxrandr2
- 25.01.21: - Add nightly tag
- 19.01.21: - Add python3-pkg-resources
- 13.01.21: - Rebase to Ubuntu Focal, see here for troubleshooting armhf.
- 12.10.20: - Add libxi6
- 12.07.20: - Add kepubify for arm64v8
- 05.06.20: - Add kepubify for x86-64 and arm32v7
- 06.05.20: - Add libxslt1.1 and update ImageMagick policy
- 19.01.20: - Adding LDAP libs.
- 13.10.19: - Migrate to Python3.
- 01.08.19: - Add libxcomposite1.
- 13.06.19: - Add docker mod to enable optional ebook conversion on x86-64. Add unrar.
- 02.06.19: - Rebase to Ubuntu Bionic & add Gdrive support.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 23.02.19: - Rebase to alpine 3.9, use repo version of imagemagick.
- 11.02.19: - Add pipeline logic and multi arch.
- 03.01.19: - Remove guest user from default app.db.
- 16.08.18: - Rebase to alpine 3.8.
- 03.07.18: - New build pushed, all versions below
67have vulnerability. - 05.01.18: - Deprecate cpu_core routine lack of scaling.
- 06.12.17: - Rebase to alpine 3.7.
- 27.11.17: - Use cpu core counting routine to speed up build time.
- 24.07.17: - Curl version for imagemagick.
- 17.07.17: - Initial release.
linuxserver/calibre¶
Calibre is a powerful and easy to use e-book manager. Users say it's outstanding and a must-have. It'll allow you to do nearly everything and it takes things a step beyond normal e-book software. It's also completely free and open source and great for both casual users and computer experts.
Supported Architectures¶
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/calibre:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
This image sets up the calibre desktop app and makes its interface available via Guacamole server in the browser. The interface is available at http://your-ip:8080 or https://your-ip:8181.
By default, there is no password set for the main gui. Optional environment variable PASSWORD will allow setting a password for the user abc, via http auth.
Port 8081 is reserved for Calibre's built-in webserver, which can be enabled within the desktop app settings, and the internal port must be set to 8081 although it will then be available at the host mapped port for external access.
Options in all KasmVNC based GUI containers¶
This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.
Optional environment variables¶
| Variable | Description |
|---|---|
| CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default 8080. |
| CUSTOM_HTTPS_PORT | Internal port the container listens on for https if it needs to be swapped from the default 8181. |
| CUSTOM_USER | HTTP Basic auth username, abc is default. |
| PASSWORD | HTTP Basic auth password, abc is default. If unset there will be no auth |
| SUBFOLDER | Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/ |
| TITLE | The page title displayed on the web browser, default "KasmVNC Client". |
| FM_HOME | This is the home directory (landing) for the file manager, default "/config". |
| START_DOCKER | If set to false a container with privilege will not automatically start the DinD Docker setup. |
| DRINODE | If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE /dev/dri/renderD128 |
Optional run configurations¶
| Variable | Description |
|---|---|
--privileged | Will start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE -v /home/user/docker-data:/var/lib/docker. |
-v /var/run/docker.sock:/var/run/docker.sock | Mount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. |
--device /dev/dri:/dev/dri | Mount a GPU into the container, this can be used in conjunction with the DRINODE environment variable to leverage a host video card for GPU accelerated appplications. Only Open Source drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau) |
Lossless mode¶
This container is capable of delivering a true lossless image at a high framerate to your web browser by changing the Stream Quality preset to "Lossless", more information here. In order to use this mode from a non localhost endpoint the HTTPS port on 8181 needs to be used. If using a reverse proxy to port 8080 specific headers will need to be set as outlined here.
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)¶
---
+ calibre - LinuxServer.io linuxserver/calibre¶
Calibre is a powerful and easy to use e-book manager. Users say it's outstanding and a must-have. It'll allow you to do nearly everything and it takes things a step beyond normal e-book software. It's also completely free and open source and great for both casual users and computer experts.
Supported Architectures¶
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/calibre:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
This image sets up the calibre desktop app and makes its interface available via Guacamole server in the browser. The interface is available at http://your-ip:8080 or https://your-ip:8181.
By default, there is no password set for the main gui. Optional environment variable PASSWORD will allow setting a password for the user abc, via http auth.
Port 8081 is reserved for Calibre's built-in webserver, which can be enabled within the desktop app settings, and the internal port must be set to 8081 although it will then be available at the host mapped port for external access.
Options in all KasmVNC based GUI containers¶
This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.
Optional environment variables¶
Variable Description CUSTOM_PORT Internal port the container listens on for http if it needs to be swapped from the default 8080. CUSTOM_HTTPS_PORT Internal port the container listens on for https if it needs to be swapped from the default 8181. CUSTOM_USER HTTP Basic auth username, abc is default. PASSWORD HTTP Basic auth password, abc is default. If unset there will be no auth SUBFOLDER Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/ TITLE The page title displayed on the web browser, default "KasmVNC Client". FM_HOME This is the home directory (landing) for the file manager, default "/config". START_DOCKER If set to false a container with privilege will not automatically start the DinD Docker setup. DRINODE If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE /dev/dri/renderD128
Optional run configurations¶
Variable Description --privilegedWill start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE -v /home/user/docker-data:/var/lib/docker. -v /var/run/docker.sock:/var/run/docker.sockMount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. --device /dev/dri:/dev/driMount a GPU into the container, this can be used in conjunction with the DRINODE environment variable to leverage a host video card for GPU accelerated appplications. Only Open Source drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau)
Lossless mode¶
This container is capable of delivering a true lossless image at a high framerate to your web browser by changing the Stream Quality preset to "Lossless", more information here. In order to use this mode from a non localhost endpoint the HTTPS port on 8181 needs to be used. If using a reverse proxy to port 8080 specific headers will need to be set as outlined here.
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)¶
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 8080Calibre desktop gui. 8181Calibre desktop gui HTTPS. 8081Calibre webserver gui.
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. PASSWORD=Optionally set a password for the gui. CLI_ARGS=Optionally pass cli start arguments to calibre.
Volume Mappings (-v)¶
Volume Function /configWhere calibre should store its database and library.
Miscellaneous Options¶
Parameter Function --security-opt seccomp=unconfinedFor Docker Engine only, many modern gui apps need this to function as syscalls are unkown to Docker.
Environment variables from files (Docker secrets)¶
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
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:
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 calibre /bin/bash- To monitor the logs of the container in realtime:
docker logs -f calibre- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' calibre- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/calibre:latest
Versions¶
- 18.03.23: - Rebase to KasmVNC base image.
- 19.10.22: - Set the window title to
Calibre. Remove websocat as it is now handled properly in the baseimage. - 18.10.22: - Deprecate Arch branch.
- 07.10.22: - Start calibre window maximized.
- 16.09.22: - Rebase to jammy.
- 24.07.22: - Add arm64 build for master branch.
- 11.07.22: - Update dependencies for Calibre 6.
- 28.05.22: - Rebase to focal.
- 31.03.22: - Fix umask.
- 28.02.22: - Add speech support to bionic image.
- 05.01.22: - Add arch branch for arm platforms.
- 20.04.21: - Fix the HOME folder.
- 19.04.21: - Add libnss3 back in. Make sure Calibre can access environment variables.
- 18.04.21: - Start calibre on container start rather than gui connect.
- 15.04.21: - Rebase to rdesktop-web baseimage. Deprecate
GUAC_USER and GUAC_PASS env vars. Existing users can set the new var PASSWORD for the user abc. - 25.09.20: - Switch to python3, add various new dependencies for calibre 5.0.
- 10.05.19: - Add new env var
CLI_ARGS to pass start arguments to calibre. - 18.03.19: - Let Calibre access environment variables, add optional umask setting.
- 23.10.19: - Remove reccomended deps and zenity for character compatibility.
- 18.10.19: - Add python-xdg.
- 08.10.19: - Add fonts-wqy-microhei ttf-wqy-zenhei fcitx-rime dependency to resolve issue with Chinese encoding.
- 04.10.19: - Add libxkbcommon-x11-0 dependency to resolve issue with Calibre 4.
- 08.08.19: - Add zenity for international character support in dialog boxes.
- 12.07.19: - Download binary from calibre website instead of github.
- 29.04.19: - Initial release.
\ No newline at end of file
+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 calibre /bin/bash- To monitor the logs of the container in realtime:
docker logs -f calibre- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' calibre- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/calibre:latest
Versions¶
- 18.03.23: - Rebase to KasmVNC base image.
- 19.10.22: - Set the window title to
Calibre. Remove websocat as it is now handled properly in the baseimage. - 18.10.22: - Deprecate Arch branch.
- 07.10.22: - Start calibre window maximized.
- 16.09.22: - Rebase to jammy.
- 24.07.22: - Add arm64 build for master branch.
- 11.07.22: - Update dependencies for Calibre 6.
- 28.05.22: - Rebase to focal.
- 31.03.22: - Fix umask.
- 28.02.22: - Add speech support to bionic image.
- 05.01.22: - Add arch branch for arm platforms.
- 20.04.21: - Fix the HOME folder.
- 19.04.21: - Add libnss3 back in. Make sure Calibre can access environment variables.
- 18.04.21: - Start calibre on container start rather than gui connect.
- 15.04.21: - Rebase to rdesktop-web baseimage. Deprecate
GUAC_USERandGUAC_PASSenv vars. Existing users can set the new varPASSWORDfor the userabc. - 25.09.20: - Switch to python3, add various new dependencies for calibre 5.0.
- 10.05.19: - Add new env var
CLI_ARGSto pass start arguments to calibre. - 18.03.19: - Let Calibre access environment variables, add optional umask setting.
- 23.10.19: - Remove reccomended deps and zenity for character compatibility.
- 18.10.19: - Add python-xdg.
- 08.10.19: - Add fonts-wqy-microhei ttf-wqy-zenhei fcitx-rime dependency to resolve issue with Chinese encoding.
- 04.10.19: - Add libxkbcommon-x11-0 dependency to resolve issue with Calibre 4.
- 08.08.19: - Add zenity for international character support in dialog boxes.
- 12.07.19: - Download binary from calibre website instead of github.
- 29.04.19: - Initial release.
DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. We recommend current users switch to linuxserver/jackett.
linuxserver/cardigann¶
Cardigann a server for adding extra indexers to Sonarr, SickRage and CouchPotato via Torznab and TorrentPotato proxies. Behind the scenes Cardigann logs in and runs searches and then transforms the results into a compatible format.
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 linuxserver/cardigann 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 | amd64-latest |
| arm64 | arm64v8-latest |
| armhf | arm32v7-latest |
Usage¶
Here are some example snippets to help you get started creating a container from this image.
docker¶
docker create \
+ cardigann - LinuxServer.io DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. We recommend current users switch to linuxserver/jackett.
linuxserver/cardigann¶
Cardigann a server for adding extra indexers to Sonarr, SickRage and CouchPotato via Torznab and TorrentPotato proxies. Behind the scenes Cardigann logs in and runs searches and then transforms the results into a compatible format.
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 linuxserver/cardigann 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 amd64-latest arm64 arm64v8-latest armhf arm32v7-latest
Usage¶
Here are some example snippets to help you get started creating a container from this image.
docker¶
docker create \
--name=cardigann \
-e PUID=1000 \
-e PGID=1000 \
@@ -26,4 +26,4 @@
restart: unless-stopped
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 5060The port for the Cardigann webinterface
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation SOCKS_PROXY=IP:PORTfor using a socks proxy (optional) HTTP_PROXY=IP:PORTfor using a HTTP proxy (optional)
Volume Mappings (-v)¶
Volume Function /configCardigann config
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:
Application Setup¶
Access the webui at <your-ip>:5060, for more information check out Cardigann.
By adding a variable to the run command, SOCKS_PROXY or HTTP_PROXY cardigann can be used with a proxy, eg -e SOCKS_PROXY=localhost:1080
The folder /config/definitions can be used to add additional tracker definitions (for more info see Additional definitions ).
Support Info¶
- Shell access whilst the container is running:
docker exec -it cardigann /bin/bash- To monitor the logs of the container in realtime:
docker logs -f cardigann- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' cardigann- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/cardigann
Versions¶
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 01.02.19: - Multi arch images and pipeline build logic
- 14.01.19: - Add multi arch and pipeline logic
- 22.08.18: - Rebase to alpine 3.8
- 06.05.18: - Use buildstage in Dockerfile
- 06.12.17: - Rebase to alpine 3.7
- 12.08.17: - Add npm install to build stage
- 25.05.17: - Rebase to alpine 3.6
- 07.02.17: - Rebase to alpine 3.5
- 03.11.16: - Compiled using sstamoulis' method
- 01.11.16: - Initial Release
\ No newline at end of file
+Application Setup¶
Access the webui at <your-ip>:5060, for more information check out Cardigann.
By adding a variable to the run command, SOCKS_PROXY or HTTP_PROXY cardigann can be used with a proxy, eg -e SOCKS_PROXY=localhost:1080
The folder /config/definitions can be used to add additional tracker definitions (for more info see Additional definitions ).
Support Info¶
- Shell access whilst the container is running:
docker exec -it cardigann /bin/bash- To monitor the logs of the container in realtime:
docker logs -f cardigann- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' cardigann- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/cardigann
Versions¶
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 01.02.19: - Multi arch images and pipeline build logic
- 14.01.19: - Add multi arch and pipeline logic
- 22.08.18: - Rebase to alpine 3.8
- 06.05.18: - Use buildstage in Dockerfile
- 06.12.17: - Rebase to alpine 3.7
- 12.08.17: - Add npm install to build stage
- 25.05.17: - Rebase to alpine 3.6
- 07.02.17: - Rebase to alpine 3.5
- 03.11.16: - Compiled using sstamoulis' method
- 01.11.16: - Initial Release
linuxserver/changedetection.io¶
Changedetection.io provides free, open-source web page monitoring, notification and change detection.
Supported Architectures¶
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/changedetection.io:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
Webui is accessible at http://SERVERIP:PORT
Please note that this image does not contain the Playwright content fetcher due to a lack of support for muslc-based systems. If you require this feature please use Selenium or the official container
For more info read the wiki.
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)¶
---
+ changedetection.io - LinuxServer.io linuxserver/changedetection.io¶
Changedetection.io provides free, open-source web page monitoring, notification and change detection.
Supported Architectures¶
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/changedetection.io:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
Webui is accessible at http://SERVERIP:PORT
Please note that this image does not contain the Playwright content fetcher due to a lack of support for muslc-based systems. If you require this feature please use Selenium or the official container
For more info read the wiki.
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)¶
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 5000WebUI
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. BASE_URL=Specify the full URL (including protocol) when running behind a reverse proxy
Volume Mappings (-v)¶
Volume Function /configContains all relevant configuration files.
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:
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:
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 changedetection.io /bin/bash- To monitor the logs of the container in realtime:
docker logs -f changedetection.io- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' changedetection.io- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/changedetection.io:latest
Versions¶
- 10.08.23: - Add poppler-utils for pdf conversion tools.
- 11.06.23: - Rebase to Alpine 3.18, deprecate armhf.
- 05.03.23: - Rebase to Alpine 3.17.
- 23.10.22: - Rebase to Alpine 3.16, migrate to s6v3.
- 09.10.22: - Add make as build dep to fix pip jq build on armhf.
- 07.08.22: - Initial release.
\ No newline at end of file
+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 changedetection.io /bin/bash- To monitor the logs of the container in realtime:
docker logs -f changedetection.io- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' changedetection.io- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/changedetection.io:latest
Versions¶
- 10.08.23: - Add poppler-utils for pdf conversion tools.
- 11.06.23: - Rebase to Alpine 3.18, deprecate armhf.
- 05.03.23: - Rebase to Alpine 3.17.
- 23.10.22: - Rebase to Alpine 3.16, migrate to s6v3.
- 09.10.22: - Add make as build dep to fix pip jq build on armhf.
- 07.08.22: - Initial release.
DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. We recommend alternative images such as: https://github.com/linuxserver/docker-pixapop/ https://github.com/linuxserver/docker-piwigo/ https://github.com/linuxserver/docker-photoshow/
linuxserver/chevereto¶
Chevereto is an image hosting software that allows you to create a beautiful and full-featured image hosting website on your own server. It's your hosting and your rules, so say goodbye to closures and restrictions.
Supported Architectures¶
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/chevereto:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ✅ | arm32v7-<version tag> |
Application Setup¶
Chevereto-Free now has a maintainer!
~~Chevereto-Free will be EOL on 2021-12-31 and no new releases will be produced for it. Our container will continue to be updated until at least that date but we cannot make any assurances beyond it.~~
Access the WebUI at
Chevereto requires a MariaDB database, we have an image available here if you require it.
If you are putting Chevereto behind a reverse proxy and need the Real IP to be passed through, edit /config/nginx/site-confs/default, and set set_real_ip_from to match the IP address/address block of your proxy server(s).
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)¶
---
+ chevereto - LinuxServer.io DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. We recommend alternative images such as: https://github.com/linuxserver/docker-pixapop/ https://github.com/linuxserver/docker-piwigo/ https://github.com/linuxserver/docker-photoshow/
linuxserver/chevereto¶
Chevereto is an image hosting software that allows you to create a beautiful and full-featured image hosting website on your own server. It's your hosting and your rules, so say goodbye to closures and restrictions.
Supported Architectures¶
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/chevereto:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ✅ arm32v7-<version tag>
Application Setup¶
Chevereto-Free now has a maintainer!
~~Chevereto-Free will be EOL on 2021-12-31 and no new releases will be produced for it. Our container will continue to be updated until at least that date but we cannot make any assurances beyond it.~~
Access the WebUI at :443. For more information, check out Chevereto Free.
Chevereto requires a MariaDB database, we have an image available here if you require it.
If you are putting Chevereto behind a reverse proxy and need the Real IP to be passed through, edit /config/nginx/site-confs/default, and set set_real_ip_from to match the IP address/address block of your proxy server(s).
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)¶
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 80http gui 443https gui
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=<TZ>Timezone (i.e., America/New_York)
Volume Mappings (-v)¶
Volume Function /configconfig directory volume mapping /datadata directory volume mapping
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:
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:
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 chevereto /bin/bash- To monitor the logs of the container in realtime:
docker logs -f chevereto- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' chevereto- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/chevereto:latest
Versions¶
- 13.06.22: - Deprecate.
- 13.11.21: - Add composer to fix missing dependencies.
- 21.10.21: - Removed deprecation warning, change reposiory links.
- 22.07.21: - Rebase to Alpine 3.14.
- 28.08.20: - Initial Release.
\ No newline at end of file
+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 chevereto /bin/bash- To monitor the logs of the container in realtime:
docker logs -f chevereto- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' chevereto- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/chevereto:latest
Versions¶
- 13.06.22: - Deprecate.
- 13.11.21: - Add composer to fix missing dependencies.
- 21.10.21: - Removed deprecation warning, change reposiory links.
- 22.07.21: - Rebase to Alpine 3.14.
- 28.08.20: - Initial Release.
linuxserver/chromium¶
Chromium is an open-source browser project that aims to build a safer, faster, and more stable way for all users to experience the web.
Supported Architectures¶
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/chromium:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
The application can be accessed at:
- http://yourhost:3000/
- https://yourhost:3001/
Options in all KasmVNC based GUI containers¶
This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.
Optional environment variables¶
| Variable | Description |
|---|---|
| CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default 3000. |
| CUSTOM_HTTPS_PORT | Internal port the container listens on for https if it needs to be swapped from the default 3001. |
| CUSTOM_USER | HTTP Basic auth username, abc is default. |
| PASSWORD | HTTP Basic auth password, abc is default. If unset there will be no auth |
| SUBFOLDER | Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/ |
| TITLE | The page title displayed on the web browser, default "KasmVNC Client". |
| FM_HOME | This is the home directory (landing) for the file manager, default "/config". |
| START_DOCKER | If set to false a container with privilege will not automatically start the DinD Docker setup. |
| DRINODE | If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE /dev/dri/renderD128 |
Optional run configurations¶
| Variable | Description |
|---|---|
--privileged | Will start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE -v /home/user/docker-data:/var/lib/docker. |
-v /var/run/docker.sock:/var/run/docker.sock | Mount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. |
--device /dev/dri:/dev/dri | Mount a GPU into the container, this can be used in conjunction with the DRINODE environment variable to leverage a host video card for GPU accelerated appplications. Only Open Source drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau) |
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)¶
---
+ chromium - LinuxServer.io linuxserver/chromium¶
Chromium is an open-source browser project that aims to build a safer, faster, and more stable way for all users to experience the web.
Supported Architectures¶
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/chromium:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
The application can be accessed at:
- http://yourhost:3000/
- https://yourhost:3001/
Options in all KasmVNC based GUI containers¶
This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.
Optional environment variables¶
Variable Description CUSTOM_PORT Internal port the container listens on for http if it needs to be swapped from the default 3000. CUSTOM_HTTPS_PORT Internal port the container listens on for https if it needs to be swapped from the default 3001. CUSTOM_USER HTTP Basic auth username, abc is default. PASSWORD HTTP Basic auth password, abc is default. If unset there will be no auth SUBFOLDER Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/ TITLE The page title displayed on the web browser, default "KasmVNC Client". FM_HOME This is the home directory (landing) for the file manager, default "/config". START_DOCKER If set to false a container with privilege will not automatically start the DinD Docker setup. DRINODE If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE /dev/dri/renderD128
Optional run configurations¶
Variable Description --privilegedWill start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE -v /home/user/docker-data:/var/lib/docker. -v /var/run/docker.sock:/var/run/docker.sockMount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. --device /dev/dri:/dev/driMount a GPU into the container, this can be used in conjunction with the DRINODE environment variable to leverage a host video card for GPU accelerated appplications. Only Open Source drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau)
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)¶
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 3000Chromium desktop gui. 3001HTTPS Chromium desktop gui.
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. CHROME_CLI=https://www.linuxserver.io/Specify one or multiple Chromium CLI flags, this string will be passed to the application in full.
Volume Mappings (-v)¶
Volume Function /configUsers home directory in the container, stores local files and settings
Miscellaneous Options¶
Parameter Function --shm-size=This is needed for any modern website to function like youtube. --security-opt seccomp=unconfinedFor Docker Engine only, many modern gui apps need this to function on older hosts as syscalls are unknown to Docker. Chromium runs in no-sandbox test mode without it.
Environment variables from files (Docker secrets)¶
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
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:
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 chromium /bin/bash- To monitor the logs of the container in realtime:
docker logs -f chromium- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' chromium- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/chromium:latest
Versions¶
- 13.05.23: - Rebase to Alpine 3.18.
- 01.04.23: - Preserve arguments passed to Chromium and restructure to use wrapper.
- 18.03.23: - Initial release.
\ No newline at end of file
+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 chromium /bin/bash- To monitor the logs of the container in realtime:
docker logs -f chromium- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' chromium- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/chromium:latest
Versions¶
- 13.05.23: - Rebase to Alpine 3.18.
- 01.04.23: - Preserve arguments passed to Chromium and restructure to use wrapper.
- 18.03.23: - Initial release.
Contact information:-¶
| Type | Address/Details |
|---|---|
| Discord | Discord |
| Forum | Linuserver.io forum |
| IRC | freenode at #linuxserver.io more information at:- IRC |
| Podcast | Covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation! Linuxserver.io Podcast |
linuxserver/ci¶
This container is not meant for public consumption as it is hard coded to LinuxServer endpoints for storage of resulting reports
The purpose of this container is to accept environment variables from our build system linuxserver/pipeline-triggers to perform basic continuous integration on the software being built.
Usage¶
The container can be run locally, but it is meant to be integrated into the LinuxServer build process:
sudo docker run --rm -i \
+ ci - LinuxServer.io
Contact information:-¶
Type Address/Details Discord Discord Forum Linuserver.io forum IRC freenode at #linuxserver.io more information at:- IRC Podcast Covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation! Linuxserver.io Podcast
linuxserver/ci¶
This container is not meant for public consumption as it is hard coded to LinuxServer endpoints for storage of resulting reports
The purpose of this container is to accept environment variables from our build system linuxserver/pipeline-triggers to perform basic continuous integration on the software being built.
Usage¶
The container can be run locally, but it is meant to be integrated into the LinuxServer build process:
sudo docker run --rm -i \
-v /var/run/docker.sock:/var/run/docker.sock \
-v /host/path:/ci/output:rw `#Optional, will contain all the files the container creates.` \
-e IMAGE="linuxserver/<dockerimage>" \
@@ -22,4 +22,4 @@
-e DRY_RUN=<optional, Set to 'true' when you don't want to upload files to S3 when testing>
-t lsiodev/ci:latest \
python3 test_build.py
-
The following line is only in this repo for loop testing:
- { date: "01.01.50:", desc: "I am the release message for this internal repo." }
\ No newline at end of file
+The following line is only in this repo for loop testing:
- { date: "01.01.50:", desc: "I am the release message for this internal repo." }
DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. We recommend looking at Hammond as a replacement: https://github.com/akhilrex/hammond
linuxserver/clarkson¶
Clarkson is a web-based dashboard application that gives you a neat and clean interface for logging your fuel fill-ups for all of your vehicles. The application has full multi-user support, as well as multiple vehicles per user. Whenever you fill-up your car or motorcycle, keep the receipt and record the data in Clarkson.
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/clarkson 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 | amd64-latest |
| arm64 | arm64v8-latest |
| armhf | arm32v7-latest |
Application Setup¶
Clarkson requires v5.7.* of MySQL and please ensure MySQL is running before starting this container.
It is preferred if you create the clarkson schema before initially running the container, then creating a user with granted permissions for the schema. Creating the schema before running the app is important as the "clarkson" user will not have permission to create the schema on your behalf. You can, of course, use the "root" user, which has the ability to create schemas automatically, but this is not recommended.
CREATE SCHEMA `clarkson`;
+ clarkson - LinuxServer.io DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. We recommend looking at Hammond as a replacement: https://github.com/akhilrex/hammond
linuxserver/clarkson¶
Clarkson is a web-based dashboard application that gives you a neat and clean interface for logging your fuel fill-ups for all of your vehicles. The application has full multi-user support, as well as multiple vehicles per user. Whenever you fill-up your car or motorcycle, keep the receipt and record the data in Clarkson.
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/clarkson 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 amd64-latest arm64 arm64v8-latest armhf arm32v7-latest
Application Setup¶
Clarkson requires v5.7.* of MySQL and please ensure MySQL is running before starting this container.
It is preferred if you create the clarkson schema before initially running the container, then creating a user with granted permissions for the schema. Creating the schema before running the app is important as the "clarkson" user will not have permission to create the schema on your behalf. You can, of course, use the "root" user, which has the ability to create schemas automatically, but this is not recommended.
CREATE SCHEMA `clarkson`;
CREATE USER 'clarkson_user' IDENTIFIED BY 'supersecretpassword';
GRANT ALL ON `clarkson`.* TO 'clarkson_user';
Once running, the container will run an initial MySQL migration, which populates the schema with all tables and procedures. The application will start immediately afterwards. You will need to register an initial user, of which will be the admin of the application. All subsequent users will be standard users. You can disable registrations after the fact by recreating the container with the ENABLE_REGISTRATIONS flag set to false. This will not hide the "Register" link, but will disable the functionality.
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)¶
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 3000WebUI
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation MYSQL_HOST=<mysql_host>Points the backend to the MySQL database. This can be either a docker hostname or an IP. MYSQL_USERNAME=<mysql_username>The user with access to the clarkson schema. MYSQL_PASSWORD=<mysql_password>The password for the user. ENABLE_REGISTRATIONS=<true/false>Defaults to false. If set to true, allows new users to register. TZ=Europe/LondonSpecify a timezone to use EG Europe/London.
Volume Mappings (-v)¶
Volume Function
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:
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:
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 clarkson /bin/bash- To monitor the logs of the container in realtime:
docker logs -f clarkson- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' clarkson- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/clarkson
Versions¶
- 19.01.22: - Deprecate.
- 02.06.20: - Rebasing to alpine 3.12.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 23.03.19: - Updating runtime dependancies for the JRE.
- 22.02.19: - Rebasing to alpine 3.9.
- 11.02.19: - Add pipeline logic and multi arch.
- 22.08.18: - Rebase to alpine linux 3.8.
- 19.02.18: - Initial Release.
\ No newline at end of file
+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 clarkson /bin/bash- To monitor the logs of the container in realtime:
docker logs -f clarkson- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' clarkson- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/clarkson
Versions¶
- 19.01.22: - Deprecate.
- 02.06.20: - Rebasing to alpine 3.12.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 23.03.19: - Updating runtime dependancies for the JRE.
- 22.02.19: - Rebasing to alpine 3.9.
- 11.02.19: - Add pipeline logic and multi arch.
- 22.08.18: - Rebase to alpine linux 3.8.
- 19.02.18: - Initial Release.
DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. We recommend looking at our code-server and openvscode-server containers as potential replacements. https://github.com/linuxserver/docker-code-server https://github.com/linuxserver/docker-openvscode-server
linuxserver/cloud9¶
Cloud9 Cloud9 is a complete web based IDE with terminal access. This container is for running their core SDK locally and developing plugins.
Supported Architectures¶
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/cloud9:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ✅ | arm32v7-<version tag> |
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
| Tag | Available | Description |
|---|---|---|
| latest | ✅ | Docker and Compose environment pre-installed |
| go | ✅ | Basic Golang environment pre-installed |
| nodejs | ✅ | Current stable NodeJS/NPM environment pre-installed |
| python | ✅ | Current Python3 environment pre-installed |
| ruby | ✅ | Current Ruby environment pre-installed |
Application Setup¶
Access the webui at http://your-ip:8000, for more information check out here.
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)¶
---
+ cloud9 - LinuxServer.io DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. We recommend looking at our code-server and openvscode-server containers as potential replacements. https://github.com/linuxserver/docker-code-server https://github.com/linuxserver/docker-openvscode-server
linuxserver/cloud9¶
Cloud9 Cloud9 is a complete web based IDE with terminal access. This container is for running their core SDK locally and developing plugins.
Supported Architectures¶
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/cloud9:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ✅ arm32v7-<version tag>
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
Tag Available Description latest ✅ Docker and Compose environment pre-installed go ✅ Basic Golang environment pre-installed nodejs ✅ Current stable NodeJS/NPM environment pre-installed python ✅ Current Python3 environment pre-installed ruby ✅ Current Ruby environment pre-installed
Application Setup¶
Access the webui at http://your-ip:8000, for more information check out here.
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)¶
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 8000The port for the Cloud9 web interface
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Europe/LondonSpecify a timezone to use EG Europe/London GITURL=https://github.com/linuxserver/docker-cloud9.gitSpecify a git repo to checkout on first startup USERNAME=Optionally specify a username for http auth PASSWORD=Optionally specify a password for http auth (if USERNAME and PASSWORD are not set, there will be no http auth)
Volume Mappings (-v)¶
Volume Function /codeOptionally if you want to mount up a local folder of code instead of checking out /var/run/docker.sockNeeded if you plan to use Docker or compose commands
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:
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:
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 cloud9 /bin/bash- To monitor the logs of the container in realtime:
docker logs -f cloud9- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' cloud9- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/cloud9:latest
Versions¶
- 23.06.22: - Deprecate image.
- 24.06.21: - Use prebuilt compose binaries for the linuxserver repo.
- 07.02.20: - Add optional http auth.
- 02.06.19: - Initial Release.
\ No newline at end of file
+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 cloud9 /bin/bash- To monitor the logs of the container in realtime:
docker logs -f cloud9- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' cloud9- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/cloud9:latest
Versions¶
- 23.06.22: - Deprecate image.
- 24.06.21: - Use prebuilt compose binaries for the linuxserver repo.
- 07.02.20: - Add optional http auth.
- 02.06.19: - Initial Release.
linuxserver/code-server¶
Code-server is VS Code running on a remote server, accessible through the browser. - Code on your Chromebook, tablet, and laptop with a consistent dev environment. - If you have a Windows or Mac workstation, more easily develop for Linux. - Take advantage of large cloud servers to speed up tests, compilations, downloads, and more. - Preserve battery life when you're on the go. - All intensive computation runs on your server. - You're no longer running excess instances of Chrome.
Supported Architectures¶
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/code-server:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
Access the webui at http://<your-ip>:8443. For github integration, drop your ssh key in to /config/.ssh. Then open a terminal from the top menu and set your github username and email via the following commands
git config --global user.name "username"
+ code-server - LinuxServer.io linuxserver/code-server¶
Code-server is VS Code running on a remote server, accessible through the browser. - Code on your Chromebook, tablet, and laptop with a consistent dev environment. - If you have a Windows or Mac workstation, more easily develop for Linux. - Take advantage of large cloud servers to speed up tests, compilations, downloads, and more. - Preserve battery life when you're on the go. - All intensive computation runs on your server. - You're no longer running excess instances of Chrome.
Supported Architectures¶
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/code-server:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
Access the webui at http://<your-ip>:8443. For github integration, drop your ssh key in to /config/.ssh. Then open a terminal from the top menu and set your github username and email via the following commands
Hashed code-server password¶
How to create the hashed password.
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)¶
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 8443web gui
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. PASSWORD=passwordOptional web gui password, if PASSWORD or HASHED_PASSWORD is not provided, there will be no auth. HASHED_PASSWORD=Optional web gui password, overrides PASSWORD, instructions on how to create it is below. SUDO_PASSWORD=passwordIf this optional variable is set, user will have sudo access in the code-server terminal with the specified password. SUDO_PASSWORD_HASH=Optionally set sudo password via hash (takes priority over SUDO_PASSWORD var). Format is $type$salt$hashed. PROXY_DOMAIN=code-server.my.domainIf this optional variable is set, this domain will be proxied for subdomain proxying. See Documentation DEFAULT_WORKSPACE=/config/workspaceIf this optional variable is set, code-server will open this directory by default
Volume Mappings (-v)¶
Volume Function /configContains all relevant configuration files.
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:
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:
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 code-server /bin/bash- To monitor the logs of the container in realtime:
docker logs -f code-server- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' code-server- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/code-server:latest
Versions¶
- 01.07.23: - Deprecate armhf. As announced here
- 05.10.22: - Install recommended deps to maintain parity with the older images.
- 29.09.22: - Rebase to jammy, switch to s6v3. Fix chown logic to skip
/config/workspace contents. - 20.02.22: - Install using the official tarballs.
- 29.12.21: - Add
install-extension as a helper for mods to install extensions. - 06.12.21: - Add
DEFAULT_WORKSPACE env var. - 29.11.21: - Rebase to Ubuntu focal.
- 16.09.21: - Fix slow
chown on large workspace (contents of workspace folder no longer chowned). - 11.07.21: - Bump node to 14 to fix builds
- 08.05.21: - Fix doc link
- 04.02.20: - Allow setting gui password via hash using env var
HASHED_PASSWORD. - 23.12.20: - Allow setting sudo password via hash using env var
SUDO_PASSWORD_HASH. - 29.05.20: - Add --domain-proxy support.
- 21.05.20: - Shrink images, install via yarn, fix arm32v7 build.
- 18.05.20: - Switch to multi-arch images, install via npm.
- 29.04.20: - Update start arguments.
- 01.04.20: - Structural changes required for v3.
- 17.01.20: - Fix artifact url retrieval from github.
- 24.10.19: - Upgrade to v2 builds.
- 28.09.19: - Update project logo.
- 21.09.19: - Add development builds/tag.
- 09.07.19: - Add optional sudo access.
- 01.07.19: - Add nano.
- 24.06.19: - Initial Release.
\ No newline at end of file
+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 code-server /bin/bash- To monitor the logs of the container in realtime:
docker logs -f code-server- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' code-server- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/code-server:latest
Versions¶
- 01.07.23: - Deprecate armhf. As announced here
- 05.10.22: - Install recommended deps to maintain parity with the older images.
- 29.09.22: - Rebase to jammy, switch to s6v3. Fix chown logic to skip
/config/workspacecontents. - 20.02.22: - Install using the official tarballs.
- 29.12.21: - Add
install-extensionas a helper for mods to install extensions. - 06.12.21: - Add
DEFAULT_WORKSPACEenv var. - 29.11.21: - Rebase to Ubuntu focal.
- 16.09.21: - Fix slow
chownon large workspace (contents of workspace folder no longer chowned). - 11.07.21: - Bump node to 14 to fix builds
- 08.05.21: - Fix doc link
- 04.02.20: - Allow setting gui password via hash using env var
HASHED_PASSWORD. - 23.12.20: - Allow setting sudo password via hash using env var
SUDO_PASSWORD_HASH. - 29.05.20: - Add --domain-proxy support.
- 21.05.20: - Shrink images, install via yarn, fix arm32v7 build.
- 18.05.20: - Switch to multi-arch images, install via npm.
- 29.04.20: - Update start arguments.
- 01.04.20: - Structural changes required for v3.
- 17.01.20: - Fix artifact url retrieval from github.
- 24.10.19: - Upgrade to v2 builds.
- 28.09.19: - Update project logo.
- 21.09.19: - Add development builds/tag.
- 09.07.19: - Add optional sudo access.
- 01.07.19: - Add nano.
- 24.06.19: - Initial Release.
DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. PLEASE MIGRATE TO CLOUD9 IF POSSIBLE linuxserver/cloud9
linuxserver/codiad¶
Codiad is a web-based IDE framework with a small footprint and minimal requirements. We have added a few plugins. More can be added in the marketplace in the WebUI.
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 linuxserver/codiad 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 | amd64-latest |
| arm64 | arm64v8-latest |
| armhf | arm32v7-latest |
Usage¶
Here are some example snippets to help you get started creating a container from this image.
docker¶
docker create \
+ codiad - LinuxServer.io DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. PLEASE MIGRATE TO CLOUD9 IF POSSIBLE linuxserver/cloud9
linuxserver/codiad¶
Codiad is a web-based IDE framework with a small footprint and minimal requirements. We have added a few plugins. More can be added in the marketplace in the WebUI.
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 linuxserver/codiad 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 amd64-latest arm64 arm64v8-latest armhf arm32v7-latest
Usage¶
Here are some example snippets to help you get started creating a container from this image.
docker¶
docker create \
--name=codiad \
-e PUID=1000 \
-e PGID=1000 \
@@ -24,4 +24,4 @@
restart: unless-stopped
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 80WebUI
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Europe/LondonSpecify a timezone to use EG Europe/London.
Volume Mappings (-v)¶
Volume Function /configWhere Codiad stores data.
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:
Support Info¶
- Shell access whilst the container is running:
docker exec -it codiad /bin/bash- To monitor the logs of the container in realtime:
docker logs -f codiad- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' codiad- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/codiad
Versions¶
- 10.06.19: - Deprecate Image.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebasing to alpine 3.9, adding ssh client.
- 16.01.19: - Add pipeline logic and multi arch.
- 26.09.18: - Add sed to init file to configure projects folder correctly.
- 04.09.18: - Rebase to alpine linux 3.8.
- 09.01.18: - Rebase to alpine linux 3.7.
- 25.05.17: - Rebase to alpine linux 3.6.
- 18.02.17: - Rebase to alpine linux 3.5.
- 14.10.16: - Add version layer information.
- 10.09.16: - Add layer badges to README.
- 06.11.15: - Initial Release.
\ No newline at end of file
+Support Info¶
- Shell access whilst the container is running:
docker exec -it codiad /bin/bash- To monitor the logs of the container in realtime:
docker logs -f codiad- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' codiad- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/codiad
Versions¶
- 10.06.19: - Deprecate Image.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebasing to alpine 3.9, adding ssh client.
- 16.01.19: - Add pipeline logic and multi arch.
- 26.09.18: - Add sed to init file to configure projects folder correctly.
- 04.09.18: - Rebase to alpine linux 3.8.
- 09.01.18: - Rebase to alpine linux 3.7.
- 25.05.17: - Rebase to alpine linux 3.6.
- 18.02.17: - Rebase to alpine linux 3.5.
- 14.10.16: - Add version layer information.
- 10.09.16: - Add layer badges to README.
- 06.11.15: - Initial Release.
DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated.
linuxserver/codimd¶
Codimd gives you access to all your files wherever you are.
CodiMD is a real-time, multi-platform collaborative markdown note editor. This means that you can write notes with other people on your desktop, tablet or even on the phone. You can sign-in via multiple auth providers like Facebook, Twitter, GitHub and many more on the homepage.
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/codimd 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 | amd64-latest |
| arm64 | arm64v8-latest |
| armhf | arm32v7-latest |
Usage¶
Here are some example snippets to help you get started creating a container from this image.
docker-compose (recommended)¶
Compatible with docker-compose v2 schemas.
version: "3"
+ codimd - LinuxServer.io DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated.
linuxserver/codimd¶
Codimd gives you access to all your files wherever you are.
CodiMD is a real-time, multi-platform collaborative markdown note editor. This means that you can write notes with other people on your desktop, tablet or even on the phone. You can sign-in via multiple auth providers like Facebook, Twitter, GitHub and many more on the homepage.
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/codimd 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 amd64-latest arm64 arm64v8-latest armhf arm32v7-latest
Usage¶
Here are some example snippets to help you get started creating a container from this image.
docker-compose (recommended)¶
Compatible with docker-compose v2 schemas.
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 3000If you wish to access this container from http://{IP}:${PORT}` this must be left unchanged.
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation DB_HOST=<hostname or ip>Host address of mysql database DB_PORT=3306Port to access mysql database default is 3306 DB_USER=codimdDatabase user DB_PASS=<secret password>Database password DB_NAME=codimdDatabase name TZ=Europe/LondonSpecify a timezone to use EG Europe/London.
Volume Mappings (-v)¶
Volume Function /configCodiMD config and configurable files
Environment variables from files (Docker secrets)¶
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
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:
Application Setup¶
THIS IMAGE IS DEPRECATED. CodiMD is rebranded as HedgeDoc and the new docker image is at linuxserver/hedgedoc.
CodiMD web interface can be accessed http://${IP}:3000/, if you want to use a custom domain or anything besides port 3000 you will need to leverage their env settings for callbacks: (specifically for CMD_DOMAIN and CMD_URL_ADDPORT)
For convience we provide a working example using Mysql as a backend in this document, if you do not wish to use our custom environment values or a Mysql database backend feel free to leverage any of the settings laid out in the link above.
To run behind a reverse proxy we have a preconfigured config using docker networking included in our LetsEncrypt image and you can read how to use this in the Reverse Proxy Confs repository
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 codimd /bin/bash- To monitor the logs of the container in realtime:
docker logs -f codimd- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' codimd- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/codimd
Versions¶
- 22.12.20: - Deprecate image in favor of the new rebranded image at linuxserver/hedgedoc.
- 23.05.19: - Initial release
\ No newline at end of file
+Application Setup¶
THIS IMAGE IS DEPRECATED. CodiMD is rebranded as HedgeDoc and the new docker image is at linuxserver/hedgedoc.
CodiMD web interface can be accessed http://${IP}:3000/, if you want to use a custom domain or anything besides port 3000 you will need to leverage their env settings for callbacks: (specifically for CMD_DOMAIN and CMD_URL_ADDPORT)
For convience we provide a working example using Mysql as a backend in this document, if you do not wish to use our custom environment values or a Mysql database backend feel free to leverage any of the settings laid out in the link above.
To run behind a reverse proxy we have a preconfigured config using docker networking included in our LetsEncrypt image and you can read how to use this in the Reverse Proxy Confs repository
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 codimd /bin/bash- To monitor the logs of the container in realtime:
docker logs -f codimd- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' codimd- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/codimd
Versions¶
- 22.12.20: - Deprecate image in favor of the new rebranded image at linuxserver/hedgedoc.
- 23.05.19: - Initial release
linuxserver/cops¶
Cops by Sébastien Lucas, now maintained by MikesPub, stands for Calibre OPDS (and HTML) Php Server.
COPS links to your Calibre library database and allows downloading and emailing of books directly from a web browser and provides a OPDS feed to connect to your devices.
Changes in your Calibre library are reflected immediately in your COPS pages.
See : COPS's home for more details.
Don't forget to check the Wiki.
Why? (taken from the author's site)¶
In my opinion Calibre is a marvelous tool but is too big and has too much dependencies to be used for its content server.
That's the main reason why I coded this OPDS server. I needed a simple tool to be installed on a small server (Seagate Dockstar in my case).
I initially thought of Calibre2OPDS but as it generate static file no search was possible.
Later I added an simple HTML catalog that should be usable on my Kobo.
So COPS's main advantages are : * No need for many dependencies. * No need for a lot of CPU or RAM. * Not much code. * Search is available. * With Dropbox / owncloud it's very easy to have an up to date OPDS server. * It was fun to code.
If you want to use the OPDS feed don't forget to specify feed.php at the end of your URL.
Supported Architectures¶
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/cops:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
Access the webui at http://<docker host ip>:80. For connecting via OPDS on a mobile device use http://<docker host ip>:80/feed.php. It is strongly suggested that you reverse proxy this prior to exposing to the internet. For more information, such as requiring credentials, check the COPS Wiki (linked above).
The linuxserver version gives you access to config_local.php in /config to customise your install to suit your needs, it also includes the dependencies required to directly view epub books in your browser.
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)¶
---
+ cops - LinuxServer.io linuxserver/cops¶
Cops by Sébastien Lucas, now maintained by MikesPub, stands for Calibre OPDS (and HTML) Php Server.
COPS links to your Calibre library database and allows downloading and emailing of books directly from a web browser and provides a OPDS feed to connect to your devices.
Changes in your Calibre library are reflected immediately in your COPS pages.
See : COPS's home for more details.
Don't forget to check the Wiki.
Why? (taken from the author's site)¶
In my opinion Calibre is a marvelous tool but is too big and has too much dependencies to be used for its content server.
That's the main reason why I coded this OPDS server. I needed a simple tool to be installed on a small server (Seagate Dockstar in my case).
I initially thought of Calibre2OPDS but as it generate static file no search was possible.
Later I added an simple HTML catalog that should be usable on my Kobo.
So COPS's main advantages are : * No need for many dependencies. * No need for a lot of CPU or RAM. * Not much code. * Search is available. * With Dropbox / owncloud it's very easy to have an up to date OPDS server. * It was fun to code.
If you want to use the OPDS feed don't forget to specify feed.php at the end of your URL.
Supported Architectures¶
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/cops:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
Access the webui at http://<docker host ip>:80. For connecting via OPDS on a mobile device use http://<docker host ip>:80/feed.php. It is strongly suggested that you reverse proxy this prior to exposing to the internet. For more information, such as requiring credentials, check the COPS Wiki (linked above).
The linuxserver version gives you access to config_local.php in /config to customise your install to suit your needs, it also includes the dependencies required to directly view epub books in your browser.
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)¶
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 80WebUI
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configCOPS Application Data. /booksCalibre metadata.db location.
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:
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:
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 cops /bin/bash- To monitor the logs of the container in realtime:
docker logs -f cops- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' cops- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/cops:latest
Versions¶
- 11.08.23: - Undeprecate and add new branch with mikespub fork which is actively maintained.
- 15.05.23: - Deprecate due to upstream dev abandonment of project.
- 13.04.23: - Move ssl.conf include to default.conf.
- 19.01.23: - Rebase to alpine 3.17 with php8.1.
- 20.08.22: - Rebasing to alpine 3.15 with php8. Restructure nginx configs (see changes announcement).
- 22.11.20: - Pin composer version to 1.10.17.
- 01.06.20: - Rebasing to alpine 3.12.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 27.02.19: - Upgrade packages during install to prevent mismatch with baseimage.
- 22.02.19: - Rebasing to alpine 3.9.
- 14.01.19: - Add multiarch and pipeline logic.
- 21.08.18: - Rebase to alpine 3.8.
- 02.07.18: - Add php7-ctype dependency.
- 08.01.18: - Rebase to alpine 3.7.
- 25.05.17: - Rebase to alpine 3.6.
- 03.04.17: - Add composer packages, reduce layers.
- 02.04.17: - Updated to version 1.1.0.
- 05.02.17: - Updated to Alpine 3.5 & PHP7.
- 24.10.16: - Updated to implement user based config.
- 24.10.16: - Updated to version 1.0.1.
- 14.10.16: - Add version layer information.
- 28.09.16: - Add php5-zlib.
- 11.09.16: - Add layer badges to README.
- 29.08.16: - Add php5-opcache.
- 28.08.16: - Add badges to README.
- 12.08.16: - Initial Release.
\ No newline at end of file
+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 cops /bin/bash- To monitor the logs of the container in realtime:
docker logs -f cops- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' cops- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/cops:latest
Versions¶
- 11.08.23: - Undeprecate and add new branch with mikespub fork which is actively maintained.
- 15.05.23: - Deprecate due to upstream dev abandonment of project.
- 13.04.23: - Move ssl.conf include to default.conf.
- 19.01.23: - Rebase to alpine 3.17 with php8.1.
- 20.08.22: - Rebasing to alpine 3.15 with php8. Restructure nginx configs (see changes announcement).
- 22.11.20: - Pin composer version to 1.10.17.
- 01.06.20: - Rebasing to alpine 3.12.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 27.02.19: - Upgrade packages during install to prevent mismatch with baseimage.
- 22.02.19: - Rebasing to alpine 3.9.
- 14.01.19: - Add multiarch and pipeline logic.
- 21.08.18: - Rebase to alpine 3.8.
- 02.07.18: - Add php7-ctype dependency.
- 08.01.18: - Rebase to alpine 3.7.
- 25.05.17: - Rebase to alpine 3.6.
- 03.04.17: - Add composer packages, reduce layers.
- 02.04.17: - Updated to version 1.1.0.
- 05.02.17: - Updated to Alpine 3.5 & PHP7.
- 24.10.16: - Updated to implement user based config.
- 24.10.16: - Updated to version 1.0.1.
- 14.10.16: - Add version layer information.
- 28.09.16: - Add php5-zlib.
- 11.09.16: - Add layer badges to README.
- 29.08.16: - Add php5-opcache.
- 28.08.16: - Add badges to README.
- 12.08.16: - Initial Release.
DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. This project is no longer maintained upstream and we will no longer be updating this image. For an alternative try: https://github.com/linuxserver/docker-radarr
linuxserver/couchpotato¶
Couchpotato is an automatic NZB and torrent downloader. You can keep a movies I want list and it will search for NZBs/torrents of these movies every X hours. Once a movie is found, it will send it to SABnzbd or download the torrent to a specified directory.
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/couchpotato 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 | amd64-latest |
| arm64 | arm64v8-latest |
| armhf | arm32v7-latest |
Application Setup¶
Access the webui at <your-ip>:5050, for more information check out CouchPotato.
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)¶
---
+ couchpotato - LinuxServer.io DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. This project is no longer maintained upstream and we will no longer be updating this image. For an alternative try: https://github.com/linuxserver/docker-radarr
linuxserver/couchpotato¶
Couchpotato is an automatic NZB and torrent downloader. You can keep a movies I want list and it will search for NZBs/torrents of these movies every X hours. Once a movie is found, it will send it to SABnzbd or download the torrent to a specified directory.
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/couchpotato 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 amd64-latest arm64 arm64v8-latest armhf arm32v7-latest
Application Setup¶
Access the webui at <your-ip>:5050, for more information check out CouchPotato.
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)¶
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 5050http gui
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Europe/LondonSpecify a timezone to use EG Europe/London
Volume Mappings (-v)¶
Volume Function /configCouchpotato Application Data. /downloadsDownloads Folder. /moviesMovie Share.
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:
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:
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 couchpotato /bin/bash- To monitor the logs of the container in realtime:
docker logs -f couchpotato- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' couchpotato- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/couchpotato
Versions¶
- 29.01.21: - Deprecate
UMASK_SET in favor of UMASK in baseimage, see above for more information. - 23.01.21: - Rebasing to alpine 3.13.
- 10.06.19: - Add back unrar & unzip that were accidentally left out during rebase.
- 06.06.19: - Rebasing to alpine 3.12.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebasing to alpine 3.9.
- 14.01.19: - Multi-arch builds.
- 16.08.18: - Rebase to alpine 3.8.
- 06.11.17: - Rebase to alpine 3.7.
- 20.07.17: - Internal git pull instead of at runtime, add UMASK_SET variable.
- 12.07.17: - Add inspect commands to README, move to jenkins build and push
- 25.05.17: - Rebase to alpine 3.6
- 07.02.17: - Rebase to alpine 3.5.
- 11.11.16: - Stop cp logging to docker log (they are accessible in the webui and the config folder).
- 30.09.16: - Fix umask.
- 09.09.16: - Add layer badges to README.
- 27.08.16: - Add badges to README.
- 08.08.16: - Rebase to alpine linux.
- 12.11.15: - Misc Code Cleanup.
- 02.10.15: - Change to python baseimage.
- 28.07.15: - Updated to latest baseimage (for testing), and a fix to autoupdate.
\ No newline at end of file
+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 couchpotato /bin/bash- To monitor the logs of the container in realtime:
docker logs -f couchpotato- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' couchpotato- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/couchpotato
Versions¶
- 29.01.21: - Deprecate
UMASK_SETin favor of UMASK in baseimage, see above for more information. - 23.01.21: - Rebasing to alpine 3.13.
- 10.06.19: - Add back unrar & unzip that were accidentally left out during rebase.
- 06.06.19: - Rebasing to alpine 3.12.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebasing to alpine 3.9.
- 14.01.19: - Multi-arch builds.
- 16.08.18: - Rebase to alpine 3.8.
- 06.11.17: - Rebase to alpine 3.7.
- 20.07.17: - Internal git pull instead of at runtime, add UMASK_SET variable.
- 12.07.17: - Add inspect commands to README, move to jenkins build and push
- 25.05.17: - Rebase to alpine 3.6
- 07.02.17: - Rebase to alpine 3.5.
- 11.11.16: - Stop cp logging to docker log (they are accessible in the webui and the config folder).
- 30.09.16: - Fix umask.
- 09.09.16: - Add layer badges to README.
- 27.08.16: - Add badges to README.
- 08.08.16: - Rebase to alpine linux.
- 12.11.15: - Misc Code Cleanup.
- 02.10.15: - Change to python baseimage.
- 28.07.15: - Updated to latest baseimage (for testing), and a fix to autoupdate.
linuxserver/daapd¶
Daapd (iTunes) media server with support for AirPlay devices, Apple Remote (and compatibles), Chromecast, MPD and internet radio.
Supported Architectures¶
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/daapd:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
Map your music folder, open up itunes on the same LAN to see your music there.
The web interface is available at http://<your ip>:3689
For further setup options of remotes etc, check out the daapd website, Owntone.
Enable spotify connect server¶
Enable the spotify connect server by creating a pipe named 'spotify' in the root of your mounted music folder (not possible on most network mounts):
mkfifo <music_folder>/spotify
+ daapd - LinuxServer.io linuxserver/daapd¶
Daapd (iTunes) media server with support for AirPlay devices, Apple Remote (and compatibles), Chromecast, MPD and internet radio.
Supported Architectures¶
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/daapd:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
Map your music folder, open up itunes on the same LAN to see your music there.
The web interface is available at http://<your ip>:3689
For further setup options of remotes etc, check out the daapd website, Owntone.
Enable spotify connect server¶
Enable the spotify connect server by creating a pipe named 'spotify' in the root of your mounted music folder (not possible on most network mounts):
The spotify connect server should show up as the 'forked-daapd' device in your Spotify application.
It is recommended to set the pipe_autostart option to true in your forked-daapd config.
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)¶
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
Networking (--net)¶
Parameter Function --net=hostShares host networking with container.
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configWhere daapd server stores its config and dbase files. /musicMap to your music folder.
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:
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:
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 daapd /bin/bash- To monitor the logs of the container in realtime:
docker logs -f daapd- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' daapd- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/daapd:latest
Versions¶
- 25.08.23: - Rebase to Alpine 3.18, remove abandoned libspotify libs.
- 05.07.23: - Deprecate armhf. As announced here
- 23.02.23: - Rebase to Alpine 3.17, migrate to s6v3.
- 31.05.22: - Make sure the user has access to the audio device.
- 31.05.22: - Add new deps, flex and bison.
- 12.02.22: - Rebase to Alpine 3.15.
- 14.09.21: - Enabled librespot. Disabled spotify on ARMv7
- 10.07.21: - Change of paths to work with the new package name, OwnTone.
- 02.04.21: - Update upstream repo, again.
- 30.03.21: - Update upstream repo.
- 06.10.20: - Enabled Spotify on Alpine 3.12 for X86_64 and ARMv7.
- 01.06.20: - Rebasing to alpine 3.12.
- 16.01.20: - Rebase to alpine linux 3.11 and build antlr3c from source.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 14.01.19: - Add pipeline logic and multi arch.
- 20.08.18: - Rebase to alpine linux 3.8.
- 09.06.18: - Use buildstage and update dependencies.
- 05.03.18: - Use updated configure ac and disable avcodecsend to hopefully mitigate crashes with V26.
- 25.02.18: - Query version before pull and build latest release.
- 03.01.18: - Deprecate cpu_core routine lack of scaling.
- 07.12.17: - Rebase to alpine linux 3.7.
- 03.12.17: - Bump to 25.0, cpu core counting routine for faster builds, linting fixes.
- 26.05.17: - Rebase to alpine linux 3.6.
- 06.02.17: - Rebase to alpine linux 3.5.
- 10.01.17: - Bump to 24.2.
- 14.10.16: - Add version layer information.
- 17.09.16: - Rebase to alpine linux, remove redundant spotify support, move to main repository.
- 28.02.16: - Add chromecast support, bump dependency versions.
- 04.01.16: - Disable ipv6 by default because in v23.4 it doesn't work in unraid with it set.
- 17.12.15: - Add in spotify support.
- 25.11.15: - Initial Release.
\ No newline at end of file
+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 daapd /bin/bash- To monitor the logs of the container in realtime:
docker logs -f daapd- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' daapd- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/daapd:latest
Versions¶
- 25.08.23: - Rebase to Alpine 3.18, remove abandoned libspotify libs.
- 05.07.23: - Deprecate armhf. As announced here
- 23.02.23: - Rebase to Alpine 3.17, migrate to s6v3.
- 31.05.22: - Make sure the user has access to the audio device.
- 31.05.22: - Add new deps, flex and bison.
- 12.02.22: - Rebase to Alpine 3.15.
- 14.09.21: - Enabled librespot. Disabled spotify on ARMv7
- 10.07.21: - Change of paths to work with the new package name, OwnTone.
- 02.04.21: - Update upstream repo, again.
- 30.03.21: - Update upstream repo.
- 06.10.20: - Enabled Spotify on Alpine 3.12 for X86_64 and ARMv7.
- 01.06.20: - Rebasing to alpine 3.12.
- 16.01.20: - Rebase to alpine linux 3.11 and build antlr3c from source.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 14.01.19: - Add pipeline logic and multi arch.
- 20.08.18: - Rebase to alpine linux 3.8.
- 09.06.18: - Use buildstage and update dependencies.
- 05.03.18: - Use updated configure ac and disable avcodecsend to hopefully mitigate crashes with V26.
- 25.02.18: - Query version before pull and build latest release.
- 03.01.18: - Deprecate cpu_core routine lack of scaling.
- 07.12.17: - Rebase to alpine linux 3.7.
- 03.12.17: - Bump to 25.0, cpu core counting routine for faster builds, linting fixes.
- 26.05.17: - Rebase to alpine linux 3.6.
- 06.02.17: - Rebase to alpine linux 3.5.
- 10.01.17: - Bump to 24.2.
- 14.10.16: - Add version layer information.
- 17.09.16: - Rebase to alpine linux, remove redundant spotify support, move to main repository.
- 28.02.16: - Add chromecast support, bump dependency versions.
- 04.01.16: - Disable ipv6 by default because in v23.4 it doesn't work in unraid with it set.
- 17.12.15: - Add in spotify support.
- 25.11.15: - Initial Release.
linuxserver/darktable¶
darktable is an open source photography workflow application and raw developer. A virtual lighttable and darkroom for photographers. It manages your digital negatives in a database, lets you view them through a zoomable lighttable and enables you to develop raw images and enhance them.
Supported Architectures¶
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/darktable:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
The application can be accessed at:
- http://yourhost:3000/
- https://yourhost:3001/
Options in all KasmVNC based GUI containers¶
This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.
Optional environment variables¶
| Variable | Description |
|---|---|
| CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default 3000. |
| CUSTOM_HTTPS_PORT | Internal port the container listens on for https if it needs to be swapped from the default 3001. |
| CUSTOM_USER | HTTP Basic auth username, abc is default. |
| PASSWORD | HTTP Basic auth password, abc is default. If unset there will be no auth |
| SUBFOLDER | Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/ |
| TITLE | The page title displayed on the web browser, default "KasmVNC Client". |
| FM_HOME | This is the home directory (landing) for the file manager, default "/config". |
| START_DOCKER | If set to false a container with privilege will not automatically start the DinD Docker setup. |
| DRINODE | If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE /dev/dri/renderD128 |
Optional run configurations¶
| Variable | Description |
|---|---|
--privileged | Will start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE -v /home/user/docker-data:/var/lib/docker. |
-v /var/run/docker.sock:/var/run/docker.sock | Mount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. |
--device /dev/dri:/dev/dri | Mount a GPU into the container, this can be used in conjunction with the DRINODE environment variable to leverage a host video card for GPU accelerated appplications. Only Open Source drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau) |
Lossless mode¶
This container is capable of delivering a true lossless image at a high framerate to your web browser by changing the Stream Quality preset to "Lossless", more information here. In order to use this mode from a non localhost endpoint the HTTPS port on 3001 needs to be used. If using a reverse proxy to port 3000 specific headers will need to be set as outlined here.
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)¶
---
+ darktable - LinuxServer.io linuxserver/darktable¶
darktable is an open source photography workflow application and raw developer. A virtual lighttable and darkroom for photographers. It manages your digital negatives in a database, lets you view them through a zoomable lighttable and enables you to develop raw images and enhance them.
Supported Architectures¶
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/darktable:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
The application can be accessed at:
- http://yourhost:3000/
- https://yourhost:3001/
Options in all KasmVNC based GUI containers¶
This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.
Optional environment variables¶
Variable Description CUSTOM_PORT Internal port the container listens on for http if it needs to be swapped from the default 3000. CUSTOM_HTTPS_PORT Internal port the container listens on for https if it needs to be swapped from the default 3001. CUSTOM_USER HTTP Basic auth username, abc is default. PASSWORD HTTP Basic auth password, abc is default. If unset there will be no auth SUBFOLDER Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/ TITLE The page title displayed on the web browser, default "KasmVNC Client". FM_HOME This is the home directory (landing) for the file manager, default "/config". START_DOCKER If set to false a container with privilege will not automatically start the DinD Docker setup. DRINODE If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE /dev/dri/renderD128
Optional run configurations¶
Variable Description --privilegedWill start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE -v /home/user/docker-data:/var/lib/docker. -v /var/run/docker.sock:/var/run/docker.sockMount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. --device /dev/dri:/dev/driMount a GPU into the container, this can be used in conjunction with the DRINODE environment variable to leverage a host video card for GPU accelerated appplications. Only Open Source drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau)
Lossless mode¶
This container is capable of delivering a true lossless image at a high framerate to your web browser by changing the Stream Quality preset to "Lossless", more information here. In order to use this mode from a non localhost endpoint the HTTPS port on 3001 needs to be used. If using a reverse proxy to port 3000 specific headers will need to be set as outlined here.
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)¶
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 3000Darktable desktop gui. 3001Darktable desktop gui HTTPS.
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configUsers home directory in the container, stores program settings and images
Miscellaneous Options¶
Parameter Function --security-opt seccomp=unconfinedFor Docker Engine only, many modern gui apps need this to function on older hosts as syscalls are unknown to Docker.
Environment variables from files (Docker secrets)¶
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
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:
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 darktable /bin/bash- To monitor the logs of the container in realtime:
docker logs -f darktable- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' darktable- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/darktable:latest
Versions¶
- 18.03.23: - Rebase to KasmVNC base image.
- 23.10.22: - Rebase to Alpine 3.16, migrate to s6v3.
- 31.12.21: - Rebase to Alpine 3.15.
- 01.10.21: - Rebase to Alpine 3.14.
- 07.04.21: - Initial release.
\ No newline at end of file
+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 darktable /bin/bash- To monitor the logs of the container in realtime:
docker logs -f darktable- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' darktable- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/darktable:latest
Versions¶
- 18.03.23: - Rebase to KasmVNC base image.
- 23.10.22: - Rebase to Alpine 3.16, migrate to s6v3.
- 31.12.21: - Rebase to Alpine 3.15.
- 01.10.21: - Rebase to Alpine 3.14.
- 07.04.21: - Initial release.
linuxserver/davos¶
Davos is an FTP automation tool that periodically scans given host locations for new files. It can be configured for various purposes, including listening for specific files to appear in the host location, ready for it to download and then move, if required. It also supports completion notifications as well as downstream API calls, to further the workflow.
Supported Architectures¶
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/davos:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
The application does not require any set up other than starting the docker container. Further documentation can be found on the davos GitHub repository page.
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)¶
---
+ davos - LinuxServer.io linuxserver/davos¶
Davos is an FTP automation tool that periodically scans given host locations for new files. It can be configured for various purposes, including listening for specific files to appear in the host location, ready for it to download and then move, if required. It also supports completion notifications as well as downstream API calls, to further the workflow.
Supported Architectures¶
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/davos:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
The application does not require any set up other than starting the docker container. Further documentation can be found on the davos GitHub repository page.
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)¶
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 8080This is the default port that davos runs under
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configdavos's config location. This is where it stores its database file and logs. /downloaddavos's file download location
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:
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:
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 davos /bin/bash- To monitor the logs of the container in realtime:
docker logs -f davos- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' davos- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/davos:latest
Versions¶
- 12.07.23: - Rebase to Alpine 3.18.
- 07.07.23: - Deprecate armhf. As announced here
- 13.02.23: - Rebase to Alpine 3.17, migrate to s6v3.
- 15.01.22: - Rebasing to alpine 3.15.
- 01.06.20: - Rebasing to alpine 3.12.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.03.19: - Updating runtime deps due to change in OpenJRE.
- 08.03.19: - Updating build environment to pass proper build flags and use gradle wrapper.
- 22.02.19: - Rebasing to alpine 3.9.
- 18.11.16: - Initial Release.
\ No newline at end of file
+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 davos /bin/bash- To monitor the logs of the container in realtime:
docker logs -f davos- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' davos- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/davos:latest
Versions¶
- 12.07.23: - Rebase to Alpine 3.18.
- 07.07.23: - Deprecate armhf. As announced here
- 13.02.23: - Rebase to Alpine 3.17, migrate to s6v3.
- 15.01.22: - Rebasing to alpine 3.15.
- 01.06.20: - Rebasing to alpine 3.12.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.03.19: - Updating runtime deps due to change in OpenJRE.
- 08.03.19: - Updating build environment to pass proper build flags and use gradle wrapper.
- 22.02.19: - Rebasing to alpine 3.9.
- 18.11.16: - Initial Release.
linuxserver/ddclient¶
Ddclient is a Perl client used to update dynamic DNS entries for accounts on Dynamic DNS Network Service Provider. It was originally written by Paul Burry and is now mostly by wimpunk. It has the capability to update more than just dyndns and it can fetch your WAN-ipaddress in a few different ways.
Supported Architectures¶
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/ddclient:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
Edit the ddclient.conf file found in your /config volume (also see official ddclient documentation). This config file has many providers to choose from and you basically just have to uncomment your provider and add username/password where requested. If you modify ddclient.conf, ddclient will automaticcaly restart and read the config.
Get dynamic IP from Fritz.Box¶
If ddclient shall fetch the dynamic (public) IP-address from a fritz.box (AVM) add the following line to /config/ddclient.conf:
use=cmd, cmd=/etc/ddclient/get-ip-from-fritzbox
+ ddclient - LinuxServer.io linuxserver/ddclient¶
Ddclient is a Perl client used to update dynamic DNS entries for accounts on Dynamic DNS Network Service Provider. It was originally written by Paul Burry and is now mostly by wimpunk. It has the capability to update more than just dyndns and it can fetch your WAN-ipaddress in a few different ways.
Supported Architectures¶
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/ddclient:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
Edit the ddclient.conf file found in your /config volume (also see official ddclient documentation). This config file has many providers to choose from and you basically just have to uncomment your provider and add username/password where requested. If you modify ddclient.conf, ddclient will automaticcaly restart and read the config.
Get dynamic IP from Fritz.Box¶
If ddclient shall fetch the dynamic (public) IP-address from a fritz.box (AVM) add the following line to /config/ddclient.conf:
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)¶
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
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configWhere ddclient should store its config files.
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:
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:
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 ddclient /bin/bash- To monitor the logs of the container in realtime:
docker logs -f ddclient- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' ddclient- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/ddclient:latest
Versions¶
- 25.08.23: - Rebase to Alpine 3.18.
- 04.07.23: - Deprecate armhf. As announced here
- 13.02.23: - Rebase to Alpine 3.17, migrate to s6v3.
- 20.10.22: - Update build instructions for 3.10.0. Update default
ddclient.conf. - 15.01.22: - Rebase to Alpine 3.15
- 15.05.21: - Distribute script 'sample-get-ip-from-fritzbox' from ddclient repo
- 08.03.21: - Added bind-tools to provide nsupdate
- 01.06.20: - Rebasing to alpine 3.12.
- 08.02.20: - Ingest from Github.
- 06.02.19: - Fix permissions.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 10.03.19: - Add perl-io-socket-inet6 for ipv6 support.
- 22.02.19: - Rebasing to alpine 3.9.
- 11.02.19: - Add pipeline logic and multi arch.
- 22.08.18: - Rebase to alpine 3.8.
- 10.08.18: - Update to ddclient v3.9.0. For Cloudflare users, please ensure you remove the line
server=www.cloudflare.com from your ddclient.conf. - 07.12.17: - Rebase to alpine 3.7.
- 28.05.17: - Rebase to alpine 3.6.
- 10.02.17: - Rebase to alpine 3.5.
- 26.11.16: - Update README to new standard and add icon and other small details.
- 29.08.16: - Initial release.
\ No newline at end of file
+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 ddclient /bin/bash- To monitor the logs of the container in realtime:
docker logs -f ddclient- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' ddclient- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/ddclient:latest
Versions¶
- 25.08.23: - Rebase to Alpine 3.18.
- 04.07.23: - Deprecate armhf. As announced here
- 13.02.23: - Rebase to Alpine 3.17, migrate to s6v3.
- 20.10.22: - Update build instructions for 3.10.0. Update default
ddclient.conf. - 15.01.22: - Rebase to Alpine 3.15
- 15.05.21: - Distribute script 'sample-get-ip-from-fritzbox' from ddclient repo
- 08.03.21: - Added bind-tools to provide nsupdate
- 01.06.20: - Rebasing to alpine 3.12.
- 08.02.20: - Ingest from Github.
- 06.02.19: - Fix permissions.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 10.03.19: - Add perl-io-socket-inet6 for ipv6 support.
- 22.02.19: - Rebasing to alpine 3.9.
- 11.02.19: - Add pipeline logic and multi arch.
- 22.08.18: - Rebase to alpine 3.8.
- 10.08.18: - Update to ddclient v3.9.0. For Cloudflare users, please ensure you remove the line
server=www.cloudflare.comfrom yourddclient.conf. - 07.12.17: - Rebase to alpine 3.7.
- 28.05.17: - Rebase to alpine 3.6.
- 10.02.17: - Rebase to alpine 3.5.
- 26.11.16: - Update README to new standard and add icon and other small details.
- 29.08.16: - Initial release.
linuxserver/deluge¶
Deluge is a lightweight, Free Software, cross-platform BitTorrent client.
- Full Encryption
- WebUI
- Plugin System
- Much more...
Supported Architectures¶
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/deluge:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
The admin interface is available at http://SERVER-IP:8112 with a default user/password of admin/deluge.
To change the password (recommended) log in to the web interface and go to Preferences->Interface->Password.
Change the inbound port to 6881 (or whichever port you've mapped for the container) under Preferences->Network, otherwise random ports will be used.
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)¶
---
+ deluge - LinuxServer.io linuxserver/deluge¶
Deluge is a lightweight, Free Software, cross-platform BitTorrent client.
- Full Encryption
- WebUI
- Plugin System
- Much more...
Supported Architectures¶
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/deluge:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
The admin interface is available at http://SERVER-IP:8112 with a default user/password of admin/deluge.
To change the password (recommended) log in to the web interface and go to Preferences->Interface->Password.
Change the inbound port to 6881 (or whichever port you've mapped for the container) under Preferences->Network, otherwise random ports will be used.
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)¶
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 8112Port for webui 6881Inbound torrent traffic (See App Setup) 6881/udpInbound torrent traffic (See App Setup)
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. DELUGE_LOGLEVEL=errorset the loglevel output when running Deluge, default is info for deluged and warning for delgued-web
Volume Mappings (-v)¶
Volume Function /configdeluge configs /downloadstorrent download directory
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:
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:
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 deluge /bin/bash- To monitor the logs of the container in realtime:
docker logs -f deluge- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' deluge- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/deluge:latest
Versions¶
- 10.08.23: - Bump unrar to 6.2.10.
- 30.06.23: - Bump unrar to 6.2.8, deprecate armhf as per https://www.linuxserver.io/armhf.
- 29.11.22: - Restore geoip using py3-geoip as an interim measure.
- 24.11.22: - Remove GeoIP packages as geoip will not build under Py 3.11 and Deluge still doesn't support geoip2.
- 22.11.22: - Update GeoIP URL for new IPFS domain.
- 29.08.22: - Rebase to Alpine Edge again to follow latest releases.
- 12.08.22: - Bump unrar to 6.1.7.
- 16.06.22: - Rebase to Alpine 3.16 from edge.
- 22.02.22: - Rebase to Alpine, config on first startup, add GeoIP.
- 15.01.22: - Rebase to Focal.
- 07.06.21: - Remove host networking from readme examples
- 23.01.21: - Deprecate
UMASK_SET in favor of UMASK in baseimage, see above for more information. - 09.05.19: - Add python3 requests and future modules.
- 24.08.19: - Add ability to set LogLevel for Deluge.
- 09.06.19: - Update to 2.x using deluge ppa.
- 02.05.19: - Install full version of 7zip.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 15.11.18: - Add deluge-console.
- 11.11.18: - Rebase to Ubuntu Bionic, add pipeline multiarch logic.
- 09.04.18: - update to libressl2.7-libssl.
- 29.03.18: - Rebase to alpine edge.
- 07.12.17: - Rebase to alpine 3.7.
- 20.11.17: - Change libressl2.6-libssl repo.
- 01.07.17: - Add curl package.
- 26.05.17: - Rebase to alpine 3.6.
- 29.04.17: - Add variable for user defined umask.
- 28.04.17: - update to libressl2.5-libssl.
- 28.12.16: - Rebase to alpine 3.5 baseimage.
- 17.11.16: - Rebase to edge baseimage.
- 13.10.16: - Switch to libressl as openssl deprecated from alpine linux and deluge dependency no longer installs
- 30.09.16: - Fix umask.
- 09.09.16: - Add layer badges to README.
- 30.08.16: - Use pip packages for some critical dependencies.
- 28.08.16: - Add badges to README.
- 15.08.16: - Rebase to alpine linux.
- 09.11.15: - Add unrar and unzip
- 15.10.15: - Initial Release.
\ No newline at end of file
+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 deluge /bin/bash- To monitor the logs of the container in realtime:
docker logs -f deluge- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' deluge- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/deluge:latest
Versions¶
- 10.08.23: - Bump unrar to 6.2.10.
- 30.06.23: - Bump unrar to 6.2.8, deprecate armhf as per https://www.linuxserver.io/armhf.
- 29.11.22: - Restore geoip using py3-geoip as an interim measure.
- 24.11.22: - Remove GeoIP packages as geoip will not build under Py 3.11 and Deluge still doesn't support geoip2.
- 22.11.22: - Update GeoIP URL for new IPFS domain.
- 29.08.22: - Rebase to Alpine Edge again to follow latest releases.
- 12.08.22: - Bump unrar to 6.1.7.
- 16.06.22: - Rebase to Alpine 3.16 from edge.
- 22.02.22: - Rebase to Alpine, config on first startup, add GeoIP.
- 15.01.22: - Rebase to Focal.
- 07.06.21: - Remove host networking from readme examples
- 23.01.21: - Deprecate
UMASK_SETin favor of UMASK in baseimage, see above for more information. - 09.05.19: - Add python3 requests and future modules.
- 24.08.19: - Add ability to set LogLevel for Deluge.
- 09.06.19: - Update to 2.x using deluge ppa.
- 02.05.19: - Install full version of 7zip.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 15.11.18: - Add deluge-console.
- 11.11.18: - Rebase to Ubuntu Bionic, add pipeline multiarch logic.
- 09.04.18: - update to libressl2.7-libssl.
- 29.03.18: - Rebase to alpine edge.
- 07.12.17: - Rebase to alpine 3.7.
- 20.11.17: - Change libressl2.6-libssl repo.
- 01.07.17: - Add curl package.
- 26.05.17: - Rebase to alpine 3.6.
- 29.04.17: - Add variable for user defined umask.
- 28.04.17: - update to libressl2.5-libssl.
- 28.12.16: - Rebase to alpine 3.5 baseimage.
- 17.11.16: - Rebase to edge baseimage.
- 13.10.16: - Switch to libressl as openssl deprecated from alpine linux and deluge dependency no longer installs
- 30.09.16: - Fix umask.
- 09.09.16: - Add layer badges to README.
- 30.08.16: - Use pip packages for some critical dependencies.
- 28.08.16: - Add badges to README.
- 15.08.16: - Rebase to alpine linux.
- 09.11.15: - Add unrar and unzip
- 15.10.15: - Initial Release.
linuxserver/digikam¶
digiKam: Professional Photo Management with the Power of Open Source
Supported Architectures¶
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/digikam:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
Mysql Internal¶
When using mysql internal mode for the database you will need to click on "Find" Button for all the required binaries (mysql_install_db,mysqladmin,mysqld). Then select the binary file and press Open.
The application can be accessed at:
- http://yourhost:3000/
- https://yourhost:3001/
Options in all KasmVNC based GUI containers¶
This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.
Optional environment variables¶
| Variable | Description |
|---|---|
| CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default 3000. |
| CUSTOM_HTTPS_PORT | Internal port the container listens on for https if it needs to be swapped from the default 3001. |
| CUSTOM_USER | HTTP Basic auth username, abc is default. |
| PASSWORD | HTTP Basic auth password, abc is default. If unset there will be no auth |
| SUBFOLDER | Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/ |
| TITLE | The page title displayed on the web browser, default "KasmVNC Client". |
| FM_HOME | This is the home directory (landing) for the file manager, default "/config". |
| START_DOCKER | If set to false a container with privilege will not automatically start the DinD Docker setup. |
| DRINODE | If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE /dev/dri/renderD128 |
Optional run configurations¶
| Variable | Description |
|---|---|
--privileged | Will start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE -v /home/user/docker-data:/var/lib/docker. |
-v /var/run/docker.sock:/var/run/docker.sock | Mount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. |
--device /dev/dri:/dev/dri | Mount a GPU into the container, this can be used in conjunction with the DRINODE environment variable to leverage a host video card for GPU accelerated appplications. Only Open Source drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau) |
Lossless mode¶
This container is capable of delivering a true lossless image at a high framerate to your web browser by changing the Stream Quality preset to "Lossless", more information here. In order to use this mode from a non localhost endpoint the HTTPS port on 3001 needs to be used. If using a reverse proxy to port 3000 specific headers will need to be set as outlined here.
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)¶
---
+ digikam - LinuxServer.io linuxserver/digikam¶
digiKam: Professional Photo Management with the Power of Open Source
Supported Architectures¶
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/digikam:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
Mysql Internal¶
When using mysql internal mode for the database you will need to click on "Find" Button for all the required binaries (mysql_install_db,mysqladmin,mysqld). Then select the binary file and press Open.
The application can be accessed at:
- http://yourhost:3000/
- https://yourhost:3001/
Options in all KasmVNC based GUI containers¶
This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.
Optional environment variables¶
Variable Description CUSTOM_PORT Internal port the container listens on for http if it needs to be swapped from the default 3000. CUSTOM_HTTPS_PORT Internal port the container listens on for https if it needs to be swapped from the default 3001. CUSTOM_USER HTTP Basic auth username, abc is default. PASSWORD HTTP Basic auth password, abc is default. If unset there will be no auth SUBFOLDER Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/ TITLE The page title displayed on the web browser, default "KasmVNC Client". FM_HOME This is the home directory (landing) for the file manager, default "/config". START_DOCKER If set to false a container with privilege will not automatically start the DinD Docker setup. DRINODE If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE /dev/dri/renderD128
Optional run configurations¶
Variable Description --privilegedWill start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE -v /home/user/docker-data:/var/lib/docker. -v /var/run/docker.sock:/var/run/docker.sockMount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. --device /dev/dri:/dev/driMount a GPU into the container, this can be used in conjunction with the DRINODE environment variable to leverage a host video card for GPU accelerated appplications. Only Open Source drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau)
Lossless mode¶
This container is capable of delivering a true lossless image at a high framerate to your web browser by changing the Stream Quality preset to "Lossless", more information here. In order to use this mode from a non localhost endpoint the HTTPS port on 3001 needs to be used. If using a reverse proxy to port 3000 specific headers will need to be set as outlined here.
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)¶
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 3000digiKam desktop gui 3001digiKam desktop gui HTTPS
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. SUBFOLDER=/Specify a subfolder to use with reverse proxies, IE /subfolder/
Volume Mappings (-v)¶
Volume Function /configUsers home directory in the container, stores database.
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:
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:
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 digikam /bin/bash- To monitor the logs of the container in realtime:
docker logs -f digikam- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' digikam- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/digikam:latest
Versions¶
- 18.03.23: - Rebase to KasmVNC base image.
- 20.01.23: - Added breeze-icons package for icon support.
- 21.11.22: - Trigger upon baseimage updates (arch being a rolling distro has too many dependency breaks otherwise). Release version will be the baseimage build date going forward.
- 20.10.22: - Migrate to s6v3.
- 07.03.22: - Add Exiftool and firefox for image exports.
- 20.02.22: - Add MariaDB, expand documentation.
- 15.02.22: - Rebase to Arch.
- 27.12.21: - Rebase to focal to resolve dependency issues.
- 27.03.21: - Download link fixed.
- 20.05.20: - Initial release.
\ No newline at end of file
+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 digikam /bin/bash- To monitor the logs of the container in realtime:
docker logs -f digikam- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' digikam- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/digikam:latest
Versions¶
- 18.03.23: - Rebase to KasmVNC base image.
- 20.01.23: - Added breeze-icons package for icon support.
- 21.11.22: - Trigger upon baseimage updates (arch being a rolling distro has too many dependency breaks otherwise). Release version will be the baseimage build date going forward.
- 20.10.22: - Migrate to s6v3.
- 07.03.22: - Add Exiftool and firefox for image exports.
- 20.02.22: - Add MariaDB, expand documentation.
- 15.02.22: - Rebase to Arch.
- 27.12.21: - Rebase to focal to resolve dependency issues.
- 27.03.21: - Download link fixed.
- 20.05.20: - Initial release.
linuxserver/dillinger¶
Dillinger is a cloud-enabled, mobile-ready, offline-storage, AngularJS powered HTML5 Markdown editor.
Supported Architectures¶
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/dillinger:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
Access the webui at http://your-ip:8080 , keep in mind that storage for this application is in your browser session not server side. Only plugin configurations will ever be stored server side.
PDF Export¶
If you need PDF export functionality you need to run the container with a custom seccomp profile because otherwise the headless Chrome instance it uses won't have sufficient permissions.
Download the pdf-export.json from this repo onto your docker host and start the container with --security-opt seccomp=/path/to/pdf-export.json. If you're using compose the format is:
security_opt:
+ dillinger - LinuxServer.io linuxserver/dillinger¶
Dillinger is a cloud-enabled, mobile-ready, offline-storage, AngularJS powered HTML5 Markdown editor.
Supported Architectures¶
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/dillinger:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
Access the webui at http://your-ip:8080 , keep in mind that storage for this application is in your browser session not server side. Only plugin configurations will ever be stored server side.
PDF Export¶
If you need PDF export functionality you need to run the container with a custom seccomp profile because otherwise the headless Chrome instance it uses won't have sufficient permissions.
Download the pdf-export.json from this repo onto your docker host and start the container with --security-opt seccomp=/path/to/pdf-export.json. If you're using compose the format is:
The original source for this seccomp profile is here.
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)¶
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 8080The port for the Dillinger web interface
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configDillinger plugin config files
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:
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:
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 dillinger /bin/bash- To monitor the logs of the container in realtime:
docker logs -f dillinger- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' dillinger- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/dillinger:latest
Versions¶
- 12.07.23: - Rebase to Alpine 3.18.
- 13.02.23: - Rebase to Alpine 3.17, migrate to s6v3.
- 19.04.22: - Rebase to Alpine.
- 31.05.19: - Initial Release.
\ No newline at end of file
+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 dillinger /bin/bash- To monitor the logs of the container in realtime:
docker logs -f dillinger- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' dillinger- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/dillinger:latest
Versions¶
- 12.07.23: - Rebase to Alpine 3.18.
- 13.02.23: - Rebase to Alpine 3.17, migrate to s6v3.
- 19.04.22: - Rebase to Alpine.
- 31.05.19: - Initial Release.
linuxserver/diskover¶
diskover is an open source file system indexer that uses Elasticsearch to index and manage data across heterogeneous storage systems.
Supported Architectures¶
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/diskover:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
This application is dependent on an ElasticSearch instance. Please see the example compose file for additional information.
The default username is diskover with the password of darkdata, access the container at http://<host-ip>/. The UI may be unusable until a valid index has been created.
The default diskover-web Constants.php file located at /config/diskover-web.conf.d/Constants.php will need to be edited to allow diskover-web to communicate with the ElasticSearch container. The following entries will need to be edited: * const ES_HOST = elasticsearch * const ES_PORT = 9200
The application doesn't start an index by default. A crontab is created inside of the /config directory and can be set up to run automated indexes of /data. Changes to this crontab file require a restart to apply. You can also manually run an index by executing /app/diskover/diskover.py either in interactive or detached mode:
docker exec -u abc -d diskover python3 /app/diskover/diskover.py -i diskover-my_index_name /dataWill run an index in the backgrounddocker exec -u abc -it diskover python3 /app/diskover/diskover.py -i diskover-my_index_name /dataWill run an index in the foreground
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'
+ diskover - LinuxServer.io linuxserver/diskover¶
diskover is an open source file system indexer that uses Elasticsearch to index and manage data across heterogeneous storage systems.
Supported Architectures¶
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/diskover:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
This application is dependent on an ElasticSearch instance. Please see the example compose file for additional information.
The default username is diskover with the password of darkdata, access the container at http://<host-ip>/. The UI may be unusable until a valid index has been created.
The default diskover-web Constants.php file located at /config/diskover-web.conf.d/Constants.php will need to be edited to allow diskover-web to communicate with the ElasticSearch container. The following entries will need to be edited: * const ES_HOST = elasticsearch * const ES_PORT = 9200
The application doesn't start an index by default. A crontab is created inside of the /config directory and can be set up to run automated indexes of /data. Changes to this crontab file require a restart to apply. You can also manually run an index by executing /app/diskover/diskover.py either in interactive or detached mode:
docker exec -u abc -d diskover python3 /app/diskover/diskover.py -i diskover-my_index_name /data Will run an index in the backgrounddocker exec -u abc -it diskover python3 /app/diskover/diskover.py -i diskover-my_index_name /data Will run an index in the foreground
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)¶
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 80diskover Web UI
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. ES_HOST=elasticsearchElasticSearch host (optional) ES_PORT=9200ElasticSearch port (optional) ES_USER=elasticElasticSearch username (optional) ES_PASS=changemeElasticSearch password (optional)
Volume Mappings (-v)¶
Volume Function /configPersistent config files /dataDefault mount point to crawl
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:
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:
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 diskover /bin/bash- To monitor the logs of the container in realtime:
docker logs -f diskover- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' diskover- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/diskover:latest
Versions¶
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 13.04.23: - Move ssl.conf include to default.conf.
- 02.03.23: - Set permissions on crontabs during init.
- 20.08.22: - Rebasing to alpine 3.17 with php8.1. Restructure nginx configs (see changes announcement).
- 25.02.22: - Add php7-sqlite3 to support rc4 release.
- 03.11.21: - Added more support for potential config files.
- 31.10.21: - Added xpack.security variable to ElasticSearch; added instructions to edit Constants.php in diskover; corrected command needed to manually generate an index in diskover
- 11.10.21: - Updated to diskover-community v2.
- 19.11.20: - Fix pip packages.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 12.04.19: - Rebase to Alpine 3.9.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 01.11.18: - Initial Release.
\ No newline at end of file
+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 diskover /bin/bash- To monitor the logs of the container in realtime:
docker logs -f diskover- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' diskover- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/diskover:latest
Versions¶
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 13.04.23: - Move ssl.conf include to default.conf.
- 02.03.23: - Set permissions on crontabs during init.
- 20.08.22: - Rebasing to alpine 3.17 with php8.1. Restructure nginx configs (see changes announcement).
- 25.02.22: - Add php7-sqlite3 to support rc4 release.
- 03.11.21: - Added more support for potential config files.
- 31.10.21: - Added xpack.security variable to ElasticSearch; added instructions to edit Constants.php in diskover; corrected command needed to manually generate an index in diskover
- 11.10.21: - Updated to diskover-community v2.
- 19.11.20: - Fix pip packages.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 12.04.19: - Rebase to Alpine 3.9.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 01.11.18: - Initial Release.
linuxserver/doc-builder¶
Expects to run as part of the LSIO CI process. Not for public consumption.
**Running against remote: **
docker run --rm \
+ linuxserver/doc-builder - LinuxServer.io linuxserver/doc-builder¶
Expects to run as part of the LSIO CI process. Not for public consumption.
**Running against remote: **
docker run --rm \
-e CONTAINER_NAME=${CONTAINER_NAME} \
-v ${TEMPDIR}:/ansible/readme \
linuxserver/doc-builder:latest
@@ -6,4 +6,4 @@
-v $(pwd):/tmp \
-e LOCAL=true \
linuxserver/doc-builder:latest
-
The output will be in a GENERATED.md in your current working directory.
The following line is only in this repo for loop testing:
- { date: "01.01.50:", desc: "I am the release message for this internal repo." }
\ No newline at end of file
+The output will be in a GENERATED.md in your current working directory.
The following line is only in this repo for loop testing:
- { date: "01.01.50:", desc: "I am the release message for this internal repo." }
DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. Docker Compose is now available from the docker repos: https://docs.docker.com/engine/install/
And also for direct download: https://github.com/docker/compose
The LinuxServer.io team brings you another container release featuring:
- regular and timely application updates
- easy user mappings (PGID, PUID)
- custom base image with s6 overlay
- weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
- regular security updates
Find us at:
- Blog - all the things you can do with our containers including How-To guides, opinions and much more!
- Discord - realtime support / chat with the community and the team.
- Discourse - post on our community forum.
- Fleet - an online web interface which displays all of our maintained images.
- GitHub - view the source for all of our repositories.
- Open Collective - please consider helping us by either donating or contributing to our budget
linuxserver/docker-compose¶
docker-compose is a tool for defining and running multi-container Docker applications. With Compose, you use a Compose file to configure your application's services. Then, using a single command, you create and start all the services from your configuration.
Supported Architectures¶
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/docker-compose:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ✅ | arm32v7-<version tag> |
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
| Tag | Available | Description |
|---|---|---|
| latest | ✅ | docker-compose v1 releases |
| alpine | ✅ | docker-compose v1 releases with our alpine baseimage |
| v2 | ✅ | docker compose v2 releases |
Usage¶
Docker cli¶
docker run --rm \
+ docker-compose - LinuxServer.io DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. Docker Compose is now available from the docker repos: https://docs.docker.com/engine/install/
And also for direct download: https://github.com/docker/compose
The LinuxServer.io team brings you another container release featuring:
- regular and timely application updates
- easy user mappings (PGID, PUID)
- custom base image with s6 overlay
- weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
- regular security updates
Find us at:
- Blog - all the things you can do with our containers including How-To guides, opinions and much more!
- Discord - realtime support / chat with the community and the team.
- Discourse - post on our community forum.
- Fleet - an online web interface which displays all of our maintained images.
- GitHub - view the source for all of our repositories.
- Open Collective - please consider helping us by either donating or contributing to our budget
linuxserver/docker-compose¶
docker-compose is a tool for defining and running multi-container Docker applications. With Compose, you use a Compose file to configure your application's services. Then, using a single command, you create and start all the services from your configuration.
Supported Architectures¶
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/docker-compose:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ✅ arm32v7-<version tag>
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
Tag Available Description latest ✅ docker-compose v1 releases alpine ✅ docker-compose v1 releases with our alpine baseimage v2 ✅ docker compose v2 releases
Usage¶
Docker cli¶
docker run --rm \
-v /var/run/docker.sock:/var/run/docker.sock \
-v "$PWD:$PWD" \
-w="$PWD" \
@@ -13,4 +13,4 @@
--pull \
-t lscr.io/linuxserver/docker-compose:latest .
The ARM variants can be built on x86_64 hardware using multiarch/qemu-user-static
Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.
Versions¶
- 16.02.23: - Deprecate image.
- 15.03.22: - Add v2 branch. Change master to only fetch v1 releases. Change alpine to only fetch v1 releases. Rebase master to focal. Rebase alpine to 3.15.
- 17.12.20: - Update run.sh with formatting changes.
- 04.10.20: - Update run.sh with changes from upstream.
- 31.08.20: - Update tox and virtualenv.
- 31.07.20: - Add support for global env var
DOCKER_COMPOSE_IMAGE_TAG in the run.sh script. - 06.07.20: - Publish docker-compose and docker-cli binaries in Github releases.
- 01.07.20: - Release alpine based images at
alpine tag. - 04.06.20: - Bump docker-cli to 19.03.8, auto-detect python3 version.
- 19.05.20: - Initial Release.
\ No newline at end of file
+Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.
Versions¶
- 16.02.23: - Deprecate image.
- 15.03.22: - Add v2 branch. Change master to only fetch v1 releases. Change alpine to only fetch v1 releases. Rebase master to focal. Rebase alpine to 3.15.
- 17.12.20: - Update run.sh with formatting changes.
- 04.10.20: - Update run.sh with changes from upstream.
- 31.08.20: - Update tox and virtualenv.
- 31.07.20: - Add support for global env var
DOCKER_COMPOSE_IMAGE_TAGin therun.shscript. - 06.07.20: - Publish docker-compose and docker-cli binaries in Github releases.
- 01.07.20: - Release alpine based images at
alpinetag. - 04.06.20: - Bump docker-cli to 19.03.8, auto-detect python3 version.
- 19.05.20: - Initial Release.
linuxserver/dokuwiki¶
Dokuwiki is a simple to use and highly versatile Open Source wiki software that doesn't require a database. It is loved by users for its clean and readable syntax. The ease of maintenance, backup and integration makes it an administrator's favorite. Built in access controls and authentication connectors make DokuWiki especially useful in the enterprise context and the large number of plugins contributed by its vibrant community allow for a broad range of use cases beyond a traditional wiki.
Supported Architectures¶
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/dokuwiki:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
Upon first install go to http://$IP:$PORT/install.php once you have completed the setup, restart the container, login as admin and set "Use nice URLs" in the admin/Configuration Settings panel to .htaccess and tick Use slash as namespace separator in URLs to enable nice URLs you will find the webui at http://$IP:$PORT/, for more info see Dokuwiki
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)¶
---
+ dokuwiki - LinuxServer.io linuxserver/dokuwiki¶
Dokuwiki is a simple to use and highly versatile Open Source wiki software that doesn't require a database. It is loved by users for its clean and readable syntax. The ease of maintenance, backup and integration makes it an administrator's favorite. Built in access controls and authentication connectors make DokuWiki especially useful in the enterprise context and the large number of plugins contributed by its vibrant community allow for a broad range of use cases beyond a traditional wiki.
Supported Architectures¶
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/dokuwiki:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
Upon first install go to http://$IP:$PORT/install.php once you have completed the setup, restart the container, login as admin and set "Use nice URLs" in the admin/Configuration Settings panel to .htaccess and tick Use slash as namespace separator in URLs to enable nice URLs you will find the webui at http://$IP:$PORT/, for more info see Dokuwiki
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)¶
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 80Application HTTP Port 443#optional Application HTTPS Port
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configConfiguration files.
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:
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:
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 dokuwiki /bin/bash- To monitor the logs of the container in realtime:
docker logs -f dokuwiki- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' dokuwiki- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/dokuwiki:latest
Versions¶
- 21.07.23: - Update built-in plugins on container update.
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 13.04.23: - Move ssl.conf include to default.conf.
- 28.12.22: - Rebase to Alpine 3.17, migrate to s6v3.
- 11.13.22: - Move lib/images/smileys/local and lib/images/interwiki outside of the container for user defined smiley and interwiki icon support.
- 20.08.22: - Rebasing to alpine 3.15 with php8. Restructure nginx configs (see changes announcement).
- 20.07.21: - Add php7-dom, fixes minor issues in sprintdoc template.
- 15.04.21: - Add
vendor folder to deny list. - 21.02.21: - Store search index outside of container, set absolute (default) path for
savedir. - 23.01.21: - Rebasing to alpine 3.13.
- 28.09.20: - Add php7-pdo_sqlite and php7-sqlite3.
- 23.09.20: - Fix php-local.ini bug introduced in the prior PR.
- 14.09.20: - Rebase to alpine 3.12. Add php7-ctype, php7-curl, php7-pdo_mysql, php7-pdo_pgsql, php7-pecl-imagick and php7-iconv. Bump upload max filesize and post max size to 100MB. Remove deprecated APP_URL env var. Fix breaking addons.
- 19.12.19: - Rebasing to alpine 3.11.
- 01.12.19: - Add php7-ldap package to support LDAP authentication.
- 28.05.19: - Initial Release.
\ No newline at end of file
+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 dokuwiki /bin/bash- To monitor the logs of the container in realtime:
docker logs -f dokuwiki- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' dokuwiki- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/dokuwiki:latest
Versions¶
- 21.07.23: - Update built-in plugins on container update.
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 13.04.23: - Move ssl.conf include to default.conf.
- 28.12.22: - Rebase to Alpine 3.17, migrate to s6v3.
- 11.13.22: - Move lib/images/smileys/local and lib/images/interwiki outside of the container for user defined smiley and interwiki icon support.
- 20.08.22: - Rebasing to alpine 3.15 with php8. Restructure nginx configs (see changes announcement).
- 20.07.21: - Add php7-dom, fixes minor issues in sprintdoc template.
- 15.04.21: - Add
vendorfolder to deny list. - 21.02.21: - Store search index outside of container, set absolute (default) path for
savedir. - 23.01.21: - Rebasing to alpine 3.13.
- 28.09.20: - Add php7-pdo_sqlite and php7-sqlite3.
- 23.09.20: - Fix php-local.ini bug introduced in the prior PR.
- 14.09.20: - Rebase to alpine 3.12. Add php7-ctype, php7-curl, php7-pdo_mysql, php7-pdo_pgsql, php7-pecl-imagick and php7-iconv. Bump upload max filesize and post max size to 100MB. Remove deprecated APP_URL env var. Fix breaking addons.
- 19.12.19: - Rebasing to alpine 3.11.
- 01.12.19: - Add php7-ldap package to support LDAP authentication.
- 28.05.19: - Initial Release.
linuxserver/domoticz¶
Domoticz is a Home Automation System that lets you monitor and configure various devices like: Lights, Switches, various sensors/meters like Temperature, Rain, Wind, UV, Electra, Gas, Water and much more. Notifications/Alerts can be sent to any mobile device.
Supported Architectures¶
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/domoticz:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
To configure Domoticz, go to the IP of your docker host on the port you configured (default 8080), and add your hardware in Setup > Hardware. The user manual is available at www.domoticz.com
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)¶
---
+ domoticz - LinuxServer.io linuxserver/domoticz¶
Domoticz is a Home Automation System that lets you monitor and configure various devices like: Lights, Switches, various sensors/meters like Temperature, Rain, Wind, UV, Electra, Gas, Water and much more. Notifications/Alerts can be sent to any mobile device.
Supported Architectures¶
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/domoticz:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
To configure Domoticz, go to the IP of your docker host on the port you configured (default 8080), and add your hardware in Setup > Hardware. The user manual is available at www.domoticz.com
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)¶
As you can see above, the device node created is ttyUSB0. It does not say where, but it's almost always in /dev/. The correct tag for passing through this USB device is '--device /dev/ttyUSB0:/dev/ttyUSB0' 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 8080WebUI 6144Domoticz communication port. 1443Domoticz communication port.
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. WEBROOT=domoticzSets webroot to domoticz for usage with subfolder reverse proxy. Not needed unless reverse proxying. DBASE=<path to database>Sets path to database. Do not set unless you know what this does.
Volume Mappings (-v)¶
Volume Function /configWhere Domoticz stores config files and data.
Device Mappings (--device)¶
Parameter Function path to deviceFor passing through USB devices.
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:
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:
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 domoticz /bin/bash- To monitor the logs of the container in realtime:
docker logs -f domoticz- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' domoticz- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/domoticz:latest
Versions¶
- 06.07.23: - Deprecate armhf. As announced here
- 20.02.23: - Migrate to s6v3.
- 15.10.22: - Remove deprecated legacy stable branches.
- 05.02.22: - Set default webroot to /. Add env. variable for setting custom databas path.
- 26.12.20: - Rebase to Ubuntu Focal, see here for troubleshooting armhf.
- 24.11.19: - Change to using domoticz builtin Lua and MQTT.
- 03.11.19: - Set capabilities for domoticz binary and move cmake from edge repo.
- 28.06.19: - Rebasing to alpine 3.10. Add iputils for ping. Fix typo in readme. Fix permissions for custom icons.
- 12.05.19: - Add boost dependencies and turn off static boost build. Bump to Alpine 3.9.
- 30.03.19: - Add env variable to set webroot.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 19.02.19: - Fix branch for version logic.
- 11.02.19: - Add pipeline logic and multi arch.
- 02.07.18: - Add openssh package.
- 01.07.18: - Fix backup/restore in webgui.
- 03.04.18: - Add dependencies for BroadlinkRM2 plugin.
- 20.01.18: - Move telldus core to repo to prevent build fail when source site goes down.
- 18.01.18: - Remove logging to syslog in the run command to prevent double logging.
- 04.01.18: - Deprecate cpu_core routine lack of scaling.
- 08.12.17: - Rebase to alpine 3.7.
- 26.11.17: - Use cpu core counting routine to speed up build time.
- 28.05.17: - Rebase to alpine 3.6.
- 26.02.17: - Add curl and replace openssl with libressl.
- 11.02.17: - Update README.
- 03.01.17: - Initial Release.
\ No newline at end of file
+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 domoticz /bin/bash- To monitor the logs of the container in realtime:
docker logs -f domoticz- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' domoticz- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/domoticz:latest
Versions¶
- 06.07.23: - Deprecate armhf. As announced here
- 20.02.23: - Migrate to s6v3.
- 15.10.22: - Remove deprecated legacy stable branches.
- 05.02.22: - Set default webroot to /. Add env. variable for setting custom databas path.
- 26.12.20: - Rebase to Ubuntu Focal, see here for troubleshooting armhf.
- 24.11.19: - Change to using domoticz builtin Lua and MQTT.
- 03.11.19: - Set capabilities for domoticz binary and move cmake from edge repo.
- 28.06.19: - Rebasing to alpine 3.10. Add iputils for ping. Fix typo in readme. Fix permissions for custom icons.
- 12.05.19: - Add boost dependencies and turn off static boost build. Bump to Alpine 3.9.
- 30.03.19: - Add env variable to set webroot.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 19.02.19: - Fix branch for version logic.
- 11.02.19: - Add pipeline logic and multi arch.
- 02.07.18: - Add openssh package.
- 01.07.18: - Fix backup/restore in webgui.
- 03.04.18: - Add dependencies for BroadlinkRM2 plugin.
- 20.01.18: - Move telldus core to repo to prevent build fail when source site goes down.
- 18.01.18: - Remove logging to syslog in the run command to prevent double logging.
- 04.01.18: - Deprecate cpu_core routine lack of scaling.
- 08.12.17: - Rebase to alpine 3.7.
- 26.11.17: - Use cpu core counting routine to speed up build time.
- 28.05.17: - Rebase to alpine 3.6.
- 26.02.17: - Add curl and replace openssl with libressl.
- 11.02.17: - Update README.
- 03.01.17: - Initial Release.
linuxserver/doplarr¶
Doplarr is an *arr request bot for Discord."
Supported Architectures¶
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/doplarr:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
Start by following the Discord setup instructions from Doplarr's readme.
NOTE: The DISCORD__TOKEN environment variable is required to run the container!
- If you are using Overseerr, fill in the Overseerr API and URL variables, and leave the Radarr/Sonarr variables blank.
- If you are using Radarr/Sonarr (and not using Overseerr), fill in the Radarr/Sonarr API and URL variables, and leave the Overseerr variables blank.
Extra java options can be passed with the JAVA_OPTS environment variable, eg -e JAVA_OPTS="-Xmx256m -Xms256m".
Review and adjust any Optional Settings from Doplarr's readme.
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)¶
---
+ doplarr - LinuxServer.io linuxserver/doplarr¶
Doplarr is an *arr request bot for Discord."
Supported Architectures¶
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/doplarr:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
Start by following the Discord setup instructions from Doplarr's readme.
NOTE: The DISCORD__TOKEN environment variable is required to run the container!
- If you are using Overseerr, fill in the Overseerr API and URL variables, and leave the Radarr/Sonarr variables blank.
- If you are using Radarr/Sonarr (and not using Overseerr), fill in the Radarr/Sonarr API and URL variables, and leave the Overseerr variables blank.
Extra java options can be passed with the JAVA_OPTS environment variable, eg -e JAVA_OPTS="-Xmx256m -Xms256m".
Review and adjust any Optional Settings from Doplarr's readme.
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)¶
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
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. DISCORD__TOKEN=Specify your discord bot token. OVERSEERR__API=Specify your Overseerr API key. Leave blank if using Radarr/Sonarr. OVERSEERR__URL=http://localhost:5055Specify your Overseerr URL. Leave blank if using Radarr/Sonarr. RADARR__API=Specify your Radarr API key. Leave blank if using Overseerr. RADARR__URL=http://localhost:7878Specify your Radarr URL. Leave blank if using Overseerr. SONARR__API=Specify your Sonarr API key. Leave blank if using Overseerr. SONARR__URL=http://localhost:8989Specify your Sonarr URL. Leave blank if using Overseerr. DISCORD__MAX_RESULTS=25Sets the maximum size of the search results selection DISCORD__REQUESTED_MSG_STYLE=:plainSets the style of the request alert message. One of :plain :embed :none SONARR__QUALITY_PROFILE=The name of the quality profile to use by default for Sonarr RADARR__QUALITY_PROFILE=The name of the quality profile to use by default for Radarr SONARR__ROOTFOLDER=The root folder to use by default for Sonarr RADARR__ROOTFOLDER=The root folder to use by default for Radarr SONARR__LANGUAGE_PROFILE=The name of the language profile to use by default for Sonarr OVERSEERR__DEFAULT_ID=The Overseerr user id to use by default if there is no associated discord account for the requester PARTIAL_SEASONS=trueSets whether users can request partial seasons. LOG_LEVEL=:infoThe log level for the logging backend. This can be changed for debugging purposes. One of trace :debug :info :warn :error :fatal :report JAVA_OPTS=For passing additional java options.
Volume Mappings (-v)¶
Volume Function /configContains all relevant configuration files.
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:
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:
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 doplarr /bin/bash- To monitor the logs of the container in realtime:
docker logs -f doplarr- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' doplarr- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/doplarr:latest
Versions¶
- 25.05.23: - Rebase to Alpine 3.18.
- 18.12.22: - Rebase to alpine 3.17, upgrade to openjdk17.
- 01.05.22: - Remove
DISCORD__ROLE_ID environment variable, see Permissions Configuration. - 30.01.22: - Variable adjustments.
- 30.01.22: - Initial Release.
\ No newline at end of file
+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 doplarr /bin/bash- To monitor the logs of the container in realtime:
docker logs -f doplarr- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' doplarr- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/doplarr:latest
Versions¶
- 25.05.23: - Rebase to Alpine 3.18.
- 18.12.22: - Rebase to alpine 3.17, upgrade to openjdk17.
- 01.05.22: - Remove
DISCORD__ROLE_IDenvironment variable, see Permissions Configuration. - 30.01.22: - Variable adjustments.
- 30.01.22: - Initial Release.
linuxserver/doublecommander¶
Double Commander is a free cross platform open source file manager with two panels side by side. It is inspired by Total Commander and features some new ideas.
Supported Architectures¶
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/doublecommander:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
The application can be accessed at:
- http://yourhost:3000/
- https://yourhost:3001/
Options in all KasmVNC based GUI containers¶
This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.
Optional environment variables¶
| Variable | Description |
|---|---|
| CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default 3000. |
| CUSTOM_HTTPS_PORT | Internal port the container listens on for https if it needs to be swapped from the default 3001. |
| CUSTOM_USER | HTTP Basic auth username, abc is default. |
| PASSWORD | HTTP Basic auth password, abc is default. If unset there will be no auth |
| SUBFOLDER | Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/ |
| TITLE | The page title displayed on the web browser, default "KasmVNC Client". |
| FM_HOME | This is the home directory (landing) for the file manager, default "/config". |
| START_DOCKER | If set to false a container with privilege will not automatically start the DinD Docker setup. |
| DRINODE | If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE /dev/dri/renderD128 |
Optional run configurations¶
| Variable | Description |
|---|---|
--privileged | Will start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE -v /home/user/docker-data:/var/lib/docker. |
-v /var/run/docker.sock:/var/run/docker.sock | Mount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. |
--device /dev/dri:/dev/dri | Mount a GPU into the container, this can be used in conjunction with the DRINODE environment variable to leverage a host video card for GPU accelerated appplications. Only Open Source drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau) |
Lossless mode¶
This container is capable of delivering a true lossless image at a high framerate to your web browser by changing the Stream Quality preset to "Lossless", more information here. In order to use this mode from a non localhost endpoint the HTTPS port on 3001 needs to be used. If using a reverse proxy to port 3000 specific headers will need to be set as outlined here.
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)¶
---
+ doublecommander - LinuxServer.io linuxserver/doublecommander¶
Double Commander is a free cross platform open source file manager with two panels side by side. It is inspired by Total Commander and features some new ideas.
Supported Architectures¶
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/doublecommander:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
The application can be accessed at:
- http://yourhost:3000/
- https://yourhost:3001/
Options in all KasmVNC based GUI containers¶
This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.
Optional environment variables¶
Variable Description CUSTOM_PORT Internal port the container listens on for http if it needs to be swapped from the default 3000. CUSTOM_HTTPS_PORT Internal port the container listens on for https if it needs to be swapped from the default 3001. CUSTOM_USER HTTP Basic auth username, abc is default. PASSWORD HTTP Basic auth password, abc is default. If unset there will be no auth SUBFOLDER Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/ TITLE The page title displayed on the web browser, default "KasmVNC Client". FM_HOME This is the home directory (landing) for the file manager, default "/config". START_DOCKER If set to false a container with privilege will not automatically start the DinD Docker setup. DRINODE If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE /dev/dri/renderD128
Optional run configurations¶
Variable Description --privilegedWill start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE -v /home/user/docker-data:/var/lib/docker. -v /var/run/docker.sock:/var/run/docker.sockMount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. --device /dev/dri:/dev/driMount a GPU into the container, this can be used in conjunction with the DRINODE environment variable to leverage a host video card for GPU accelerated appplications. Only Open Source drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau)
Lossless mode¶
This container is capable of delivering a true lossless image at a high framerate to your web browser by changing the Stream Quality preset to "Lossless", more information here. In order to use this mode from a non localhost endpoint the HTTPS port on 3001 needs to be used. If using a reverse proxy to port 3000 specific headers will need to be set as outlined here.
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)¶
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 3000Double Commander desktop gui. 3001Double Commander desktop gui HTTPS.
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configUsers home directory in the container, stores program settings. /dataHost data directories, mount as many as needed.
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:
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:
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 doublecommander /bin/bash- To monitor the logs of the container in realtime:
docker logs -f doublecommander- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' doublecommander- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/doublecommander:latest
Versions¶
- 05.07.23: - Deprecate armhf. As announced here
- 18.03.23: - Rebase to KasmVNC base image.
- 16.09.22: - Migrate to s6v3.
- 15.02.21: - Rebase to Ubuntu Jammy.
- 14.12.21: - Rebase to Ubuntu focal.
- 25.03.20: - Initial release.
\ No newline at end of file
+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 doublecommander /bin/bash- To monitor the logs of the container in realtime:
docker logs -f doublecommander- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' doublecommander- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/doublecommander:latest
Versions¶
- 05.07.23: - Deprecate armhf. As announced here
- 18.03.23: - Rebase to KasmVNC base image.
- 16.09.22: - Migrate to s6v3.
- 15.02.21: - Rebase to Ubuntu Jammy.
- 14.12.21: - Rebase to Ubuntu focal.
- 25.03.20: - Initial release.
linuxserver/duckdns¶
Duckdns is a free service which will point a DNS (sub domains of duckdns.org) to an IP of your choice. The service is completely free, and doesn't require reactivation or forum posts to maintain its existence.
Supported Architectures¶
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/duckdns:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
- Go to the duckdns website, register your subdomain(s) and retrieve your token
- Create a container with your subdomain(s) and token
- It will update your IP with the DuckDNS service every 5 minutes (with a random jitter)
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)¶
---
+ duckdns - LinuxServer.io linuxserver/duckdns¶
Duckdns is a free service which will point a DNS (sub domains of duckdns.org) to an IP of your choice. The service is completely free, and doesn't require reactivation or forum posts to maintain its existence.
Supported Architectures¶
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/duckdns:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
- Go to the duckdns website, register your subdomain(s) and retrieve your token
- Create a container with your subdomain(s) and token
- It will update your IP with the DuckDNS service every 5 minutes (with a random jitter)
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)¶
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
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. SUBDOMAINS=subdomain1,subdomain2multiple subdomains allowed, comma separated, no spaces TOKEN=tokenDuckDNS token LOG_FILE=falseSet to true to log to file (also need to map /config).
Volume Mappings (-v)¶
Volume Function /configUsed in conjunction with logging to file.
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:
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:
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 duckdns /bin/bash- To monitor the logs of the container in realtime:
docker logs -f duckdns- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' duckdns- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/duckdns:latest
Versions¶
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 02.03.23: - Rework shell scripts and cron logic.
- 13.02.23: - Rebase to alpine 3.17.
- 23.09.22: - Rebase to alpine 3.16 and s6v3.
- 19.09.22: - Rebase to alpine 3.15.
- 17.05.22: - Don't allow insecure connections and add timeout.
- 17.05.22: - Add random jitter to update time.
- 23.02.22: - Append to log file instead of overwriting every time.
- 03.05.21: - Re-adjust cron timings to prevent peak times, update code formatting.
- 23.01.21: - Rebasing to alpine 3.13.
- 01.06.20: - Rebasing to alpine 3.12.
- 13.04.20: - Add donation links for DuckDNS.
- 19.12.19: - Rebasing to alpine 3.11.
- 24.09.19: - Fix perms on github and remove chmod that can stall the container.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebasing to alpine 3.9.
- 08.02.19: - Update readme with optional parameters.
- 10.12.18: - Fix docker compose example.
- 15.10.18: - Multi-arch image.
- 22.08.18: - Rebase to alpine 3.8.
- 08.12.17: - Rebase to alpine 3.7.
- 28.05.17: - Rebase to alpine 3.6.
- 09.02.17: - Rebase to alpine 3.5.
- 17.11.16: - Initial release.
\ No newline at end of file
+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 duckdns /bin/bash- To monitor the logs of the container in realtime:
docker logs -f duckdns- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' duckdns- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/duckdns:latest
Versions¶
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 02.03.23: - Rework shell scripts and cron logic.
- 13.02.23: - Rebase to alpine 3.17.
- 23.09.22: - Rebase to alpine 3.16 and s6v3.
- 19.09.22: - Rebase to alpine 3.15.
- 17.05.22: - Don't allow insecure connections and add timeout.
- 17.05.22: - Add random jitter to update time.
- 23.02.22: - Append to log file instead of overwriting every time.
- 03.05.21: - Re-adjust cron timings to prevent peak times, update code formatting.
- 23.01.21: - Rebasing to alpine 3.13.
- 01.06.20: - Rebasing to alpine 3.12.
- 13.04.20: - Add donation links for DuckDNS.
- 19.12.19: - Rebasing to alpine 3.11.
- 24.09.19: - Fix perms on github and remove chmod that can stall the container.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebasing to alpine 3.9.
- 08.02.19: - Update readme with optional parameters.
- 10.12.18: - Fix docker compose example.
- 15.10.18: - Multi-arch image.
- 22.08.18: - Rebase to alpine 3.8.
- 08.12.17: - Rebase to alpine 3.7.
- 28.05.17: - Rebase to alpine 3.6.
- 09.02.17: - Rebase to alpine 3.5.
- 17.11.16: - Initial release.
linuxserver/duplicati¶
Duplicati works with standard protocols like FTP, SSH, WebDAV as well as popular services like Microsoft OneDrive, Amazon Cloud Drive & S3, Google Drive, box.com, Mega, hubiC and many others.
Supported Architectures¶
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/duplicati:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
| Tag | Available | Description |
|---|---|---|
| latest | ✅ | Beta releases of Duplicati |
| development | ✅ | Canary releases of Duplicati |
| ## Application Setup |
The webui is at <your ip>:8200 , create backup jobs etc via the webui, for local backups select /backups as the destination. For more information see Duplicati.
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)¶
---
+ duplicati - LinuxServer.io linuxserver/duplicati¶
Duplicati works with standard protocols like FTP, SSH, WebDAV as well as popular services like Microsoft OneDrive, Amazon Cloud Drive & S3, Google Drive, box.com, Mega, hubiC and many others.
Supported Architectures¶
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/duplicati:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
Tag Available Description latest ✅ Beta releases of Duplicati development ✅ Canary releases of Duplicati ## Application Setup
The webui is at <your ip>:8200 , create backup jobs etc via the webui, for local backups select /backups as the destination. For more information see Duplicati.
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)¶
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 8200http gui
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. CLI_ARGS=Optionally specify any CLI variables you want to launch the app with
Volume Mappings (-v)¶
Volume Function /configContains all relevant configuration files. /backupsPath to store local backups. /sourcePath to source for files to backup.
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:
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:
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 duplicati /bin/bash- To monitor the logs of the container in realtime:
docker logs -f duplicati- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' duplicati- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/duplicati:latest
Versions¶
- 15.02.23: - Deprecate armhf.
- 03.08.22: - Deprecate armhf.
- 25.04.22: - Rebase to mono:focal.
- 01.08.19: - Rebase to Linuxserver LTS mono version.
- 16.07.19: - Allow for additional command line arguments in an environment variable.
- 28.06.19: - Rebase to bionic.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 28.02.19: - Allow access from all hostnames, clarify info on image tags.
- 13.01.19: - Use jq instead of awk in dockerfiles.
- 11.01.19: - Multi-arch image.
- 09.12.17: - Fix continuation lines.
- 31.08.17: - Build only beta or release versions (thanks deasmi).
- 24.04.17: - Initial release.
\ No newline at end of file
+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 duplicati /bin/bash- To monitor the logs of the container in realtime:
docker logs -f duplicati- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' duplicati- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/duplicati:latest
Versions¶
- 15.02.23: - Deprecate armhf.
- 03.08.22: - Deprecate armhf.
- 25.04.22: - Rebase to mono:focal.
- 01.08.19: - Rebase to Linuxserver LTS mono version.
- 16.07.19: - Allow for additional command line arguments in an environment variable.
- 28.06.19: - Rebase to bionic.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 28.02.19: - Allow access from all hostnames, clarify info on image tags.
- 13.01.19: - Use jq instead of awk in dockerfiles.
- 11.01.19: - Multi-arch image.
- 09.12.17: - Fix continuation lines.
- 31.08.17: - Build only beta or release versions (thanks deasmi).
- 24.04.17: - Initial release.
linuxserver/emby¶
Emby organizes video, music, live TV, and photos from personal media libraries and streams them to smart TVs, streaming boxes and mobile devices. This container is packaged as a standalone emby Media Server.
Supported Architectures¶
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/emby:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
| Tag | Available | Description |
|---|---|---|
| latest | ✅ | Stable emby releases |
| beta | ✅ | Beta emby releases |
| ## Application Setup |
Webui can be found at http://<your-ip>:8096
Emby has very complete and verbose documentation located here .
Hardware acceleration users for Intel Quicksync and AMD VAAPI will need to mount their /dev/dri video device inside of the container by passing the following command when running or creating the container:
--device=/dev/dri:/dev/dri
We will automatically ensure the abc user inside of the container has the proper permissions to access this device.
Hardware acceleration users for Nvidia will need to install the container runtime provided by Nvidia on their host, instructions can be found here:
https://github.com/NVIDIA/nvidia-docker
We automatically add the necessary environment variable that will utilise all the features available on a GPU on the host. Once nvidia-docker is installed on your host you will need to re/create the docker container with the nvidia container runtime --runtime=nvidia and add an environment variable -e NVIDIA_VISIBLE_DEVICES=all (can also be set to a specific gpu's UUID, this can be discovered by running nvidia-smi --query-gpu=gpu_name,gpu_uuid --format=csv ). NVIDIA automatically mounts the GPU and drivers from your host into the emby docker.
OpenMAX (Raspberry Pi)¶
Hardware acceleration users for Raspberry Pi OpenMAX will need to mount their /dev/vchiq video device inside of the container and their system OpenMax libs by passing the following options when running or creating the container:
--device=/dev/vchiq:/dev/vchiq
+ emby - LinuxServer.io linuxserver/emby¶
Emby organizes video, music, live TV, and photos from personal media libraries and streams them to smart TVs, streaming boxes and mobile devices. This container is packaged as a standalone emby Media Server.
Supported Architectures¶
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/emby:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
Tag Available Description latest ✅ Stable emby releases beta ✅ Beta emby releases ## Application Setup
Webui can be found at http://<your-ip>:8096
Emby has very complete and verbose documentation located here .
Hardware acceleration users for Intel Quicksync and AMD VAAPI will need to mount their /dev/dri video device inside of the container by passing the following command when running or creating the container:
--device=/dev/dri:/dev/dri
We will automatically ensure the abc user inside of the container has the proper permissions to access this device.
Hardware acceleration users for Nvidia will need to install the container runtime provided by Nvidia on their host, instructions can be found here:
https://github.com/NVIDIA/nvidia-docker
We automatically add the necessary environment variable that will utilise all the features available on a GPU on the host. Once nvidia-docker is installed on your host you will need to re/create the docker container with the nvidia container runtime --runtime=nvidia and add an environment variable -e NVIDIA_VISIBLE_DEVICES=all (can also be set to a specific gpu's UUID, this can be discovered by running nvidia-smi --query-gpu=gpu_name,gpu_uuid --format=csv ). NVIDIA automatically mounts the GPU and drivers from your host into the emby docker.
OpenMAX (Raspberry Pi)¶
Hardware acceleration users for Raspberry Pi OpenMAX will need to mount their /dev/vchiq video device inside of the container and their system OpenMax libs by passing the following options when running or creating the container:
V4L2 (Raspberry Pi)¶
Hardware acceleration users for Raspberry Pi V4L2 will need to mount their /dev/video1X devices inside of the container by passing the following options when running or creating the container:
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 8096Http webUI. 8920Https webUI (you need to setup your own certificate).
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configEmby data storage location. This can grow very large, 50gb+ is likely for a large collection. /data/tvshowsMedia goes here. Add as many as needed e.g. /data/movies, /data/tv, etc. /data/moviesMedia goes here. Add as many as needed e.g. /data/movies, /data/tv, etc. /opt/vc/libPath for Raspberry Pi OpenMAX libs optional.
Device Mappings (--device)¶
Parameter Function /dev/driOnly needed if you want to use your Intel or AMD GPU for hardware accelerated video encoding (vaapi). /dev/vchiqOnly needed if you want to use your Raspberry Pi OpenMax video encoding (Bellagio). /dev/video10Only needed if you want to use your Raspberry Pi V4L2 video encoding. /dev/video11Only needed if you want to use your Raspberry Pi V4L2 video encoding. /dev/video12Only needed if you want to use your Raspberry Pi V4L2 video encoding.
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:
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:
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 emby /bin/bash- To monitor the logs of the container in realtime:
docker logs -f emby- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' emby- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/emby:latest
Versions¶
- 06.07.23: - Deprecate armhf. As announced here
- 08.06.23: - Fix package extraction so it doesn't change /tmp perms.
- 31.05.23: - Use upstream deb packages instead of rpm.
- 26.09.22: - Update chown behavior.
- 18.09.22: - Migrate to s6v3, rebase to Ubuntu Jammy.
- 19.05.21: - Structural changes upstream.
- 17.01.21: - Deprecate
UMASK_SET in favor of UMASK in baseimage, see above for more information. Remove no longer used mapping for /transcode. - 21.12.20: - Rebase to Focal, see here for troubleshooting armhf.
- 03.11.20: - Fix issue with missing samba folder.
- 13.11.20: - Fix issue with samba and ffmpeg.
- 03.07.20: - Add support for amd vaapi hw transcode.
- 29.02.20: - Add v4l2 support on Raspberry Pi.
- 26.02.20: - Add openmax support on Raspberry Pi.
- 15.02.20: - Allow restarting emby from the gui (also allows for auto restarts after addon updates).
- 02.10.19: - Improve permission fixing for render and dvb devices.
- 13.08.19: - Add umask environment variable.
- 24.06.19: - Fix typos in readme.
- 30.05.19: - Initial release.
\ No newline at end of file
+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 emby /bin/bash- To monitor the logs of the container in realtime:
docker logs -f emby- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' emby- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/emby:latest
Versions¶
- 06.07.23: - Deprecate armhf. As announced here
- 08.06.23: - Fix package extraction so it doesn't change /tmp perms.
- 31.05.23: - Use upstream deb packages instead of rpm.
- 26.09.22: - Update chown behavior.
- 18.09.22: - Migrate to s6v3, rebase to Ubuntu Jammy.
- 19.05.21: - Structural changes upstream.
- 17.01.21: - Deprecate
UMASK_SETin favor of UMASK in baseimage, see above for more information. Remove no longer used mapping for /transcode. - 21.12.20: - Rebase to Focal, see here for troubleshooting armhf.
- 03.11.20: - Fix issue with missing samba folder.
- 13.11.20: - Fix issue with samba and ffmpeg.
- 03.07.20: - Add support for amd vaapi hw transcode.
- 29.02.20: - Add v4l2 support on Raspberry Pi.
- 26.02.20: - Add openmax support on Raspberry Pi.
- 15.02.20: - Allow restarting emby from the gui (also allows for auto restarts after addon updates).
- 02.10.19: - Improve permission fixing for render and dvb devices.
- 13.08.19: - Add umask environment variable.
- 24.06.19: - Fix typos in readme.
- 30.05.19: - Initial release.
linuxserver/embystat¶
Embystat is a personal web server that can calculate all kinds of statistics from your (local) Emby server. Just install this on your server and let him calculate all kinds of fun stuff.
Supported Architectures¶
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/embystat:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
Access the webui at <your-ip>:6555. Follow the setup wizard on initial install. Then configure the required services.
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)¶
---
+ embystat - LinuxServer.io linuxserver/embystat¶
Embystat is a personal web server that can calculate all kinds of statistics from your (local) Emby server. Just install this on your server and let him calculate all kinds of fun stuff.
Supported Architectures¶
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/embystat:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
Access the webui at <your-ip>:6555. Follow the setup wizard on initial install. Then configure the required services.
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)¶
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 6555web gui
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configContains all relevant configuration files.
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:
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:
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 embystat /bin/bash- To monitor the logs of the container in realtime:
docker logs -f embystat- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' embystat- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/embystat:latest
Versions¶
- 03.07.23: - Deprecate armhf. As announced here
- 11.06.22: - Rebase to focal, update disable updates flag.
- 08.04.20: - Structural changes for beta18.
- 04.12.19: - Disable in app updates.
- 12.11.19: - Multi-arch builds.
- 10.09.19: - Initial Release.
\ No newline at end of file
+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 embystat /bin/bash- To monitor the logs of the container in realtime:
docker logs -f embystat- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' embystat- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/embystat:latest
Versions¶
- 03.07.23: - Deprecate armhf. As announced here
- 11.06.22: - Rebase to focal, update disable updates flag.
- 08.04.20: - Structural changes for beta18.
- 04.12.19: - Disable in app updates.
- 12.11.19: - Multi-arch builds.
- 10.09.19: - Initial Release.
linuxserver/emulatorjs¶
Emulatorjs - In browser web based emulation portable to nearly any device for many retro consoles. A mix of emulators is used between Libretro and EmulatorJS.
Supported Architectures¶
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/emulatorjs:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
The Backend can be accessed at:
- http://yourhost:3000/
The first thing you will need to do is click to download the default art/configs from this interface, this will setup a skeleton directory in your /data mount. From there add roms to the respective roms directories and follow the on screen instructions to add them to your web frontend running on port 80.
The frontend application has been initially optimized around being used with a standard gamepad (more specifically for modern Xbox consoles that have chromium based Edge browsers). The navigation revolves around the up/down/left/right keys to browse the menus and launch games. Mobile browsers will function, just keep in mind compatibility will be reduced especially for CD based games.
It is important to note that some of the current emulators used for this frontend are obfuscated code, efforts are being made to reverse engineer it but you should know it can potentially reach out to third party services if you manually enable features like netplay (this should never happen in a stock setup). The point of this message is that on top of the de-obfuscation effort there is also effort to stop using binary blobs and shift to built from source libretro emscripten blobs, for now this web based emulation stack is the best for useability and compatibility. We are in the process to transitioning to libretro cores for emulators, currently 27/30 emulators have been replaced.
For Xbox users please click the select button a couple times after launching a game to ensure the B button does not trigger a "back" action in the browser. (official name "view button" it is the two small squares) Exiting the controller mode and back to browser controls can be triggered by holding the start button for 3 seconds. (official name "menu button" the three lines) You will be unable to use features like save states and modify controller layouts on the emulatorjs based emulators currently as I have not determined a methodology of re-entering controller mode once you exit it. All normal game saves will function given you exit the game play screen cleanly using the B button for back this includes multi disc games for psx. Your game saves are stored in browser storage by hostname so if you make any changes to your local hosted setup (port or IP) the saves will not follow with it. For libretro based emulators you can use the button combination start+select+L+R to access the libretro menu and change settings/save or load/etc.
We know about most of the oddities like crackling sound for some emulators, rendering issues, and games unreliably auto launching to fullscreen. In general full CD games on the Xbox web browser do not seem to work due to their size if you have a chd/pbp less than 450 megs it will run. Edge on Xbox has some kind of undocumented ram limitation of about a gigabyte. Until all emulators are transitioned to libretro cores the oddities of using self hosted EmulatorJS will not be something that can or should be solved using hacky workarounds interacting with obfuscated code. Just keep in mind these are full blown machine emulators running in Javascript in a browser, do not expect bare metal performance.
Mounting in existing rom directories can be achieved by pointing to the default folder structure, IE lets say you would like to mount your NES library:
-v /path/to/nes/roms:/data/nes/roms
The folder names are: * 3do * arcade * atari2600 * atari7800 * colecovision * doom * gb * gba * gbc * jaguar * lynx * msx * n64 * nds * nes * ngp * odyssey2 * pce * psx * sega32x * segaCD * segaGG * segaMD * segaMS * segaSaturn * segaSG * snes * vb * vectrex * ws
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)¶
---
+ emulatorjs - LinuxServer.io linuxserver/emulatorjs¶
Emulatorjs - In browser web based emulation portable to nearly any device for many retro consoles. A mix of emulators is used between Libretro and EmulatorJS.
Supported Architectures¶
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/emulatorjs:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
The Backend can be accessed at:
- http://yourhost:3000/
The first thing you will need to do is click to download the default art/configs from this interface, this will setup a skeleton directory in your /data mount. From there add roms to the respective roms directories and follow the on screen instructions to add them to your web frontend running on port 80.
The frontend application has been initially optimized around being used with a standard gamepad (more specifically for modern Xbox consoles that have chromium based Edge browsers). The navigation revolves around the up/down/left/right keys to browse the menus and launch games. Mobile browsers will function, just keep in mind compatibility will be reduced especially for CD based games.
It is important to note that some of the current emulators used for this frontend are obfuscated code, efforts are being made to reverse engineer it but you should know it can potentially reach out to third party services if you manually enable features like netplay (this should never happen in a stock setup). The point of this message is that on top of the de-obfuscation effort there is also effort to stop using binary blobs and shift to built from source libretro emscripten blobs, for now this web based emulation stack is the best for useability and compatibility. We are in the process to transitioning to libretro cores for emulators, currently 27/30 emulators have been replaced.
For Xbox users please click the select button a couple times after launching a game to ensure the B button does not trigger a "back" action in the browser. (official name "view button" it is the two small squares) Exiting the controller mode and back to browser controls can be triggered by holding the start button for 3 seconds. (official name "menu button" the three lines) You will be unable to use features like save states and modify controller layouts on the emulatorjs based emulators currently as I have not determined a methodology of re-entering controller mode once you exit it. All normal game saves will function given you exit the game play screen cleanly using the B button for back this includes multi disc games for psx. Your game saves are stored in browser storage by hostname so if you make any changes to your local hosted setup (port or IP) the saves will not follow with it. For libretro based emulators you can use the button combination start+select+L+R to access the libretro menu and change settings/save or load/etc.
We know about most of the oddities like crackling sound for some emulators, rendering issues, and games unreliably auto launching to fullscreen. In general full CD games on the Xbox web browser do not seem to work due to their size if you have a chd/pbp less than 450 megs it will run. Edge on Xbox has some kind of undocumented ram limitation of about a gigabyte. Until all emulators are transitioned to libretro cores the oddities of using self hosted EmulatorJS will not be something that can or should be solved using hacky workarounds interacting with obfuscated code. Just keep in mind these are full blown machine emulators running in Javascript in a browser, do not expect bare metal performance.
Mounting in existing rom directories can be achieved by pointing to the default folder structure, IE lets say you would like to mount your NES library:
-v /path/to/nes/roms:/data/nes/roms
The folder names are: * 3do * arcade * atari2600 * atari7800 * colecovision * doom * gb * gba * gbc * jaguar * lynx * msx * n64 * nds * nes * ngp * odyssey2 * pce * psx * sega32x * segaCD * segaGG * segaMD * segaMS * segaSaturn * segaSG * snes * vb * vectrex * ws
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)¶
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 3000Rom/artwork management interface, used to generate/manage config files and download artwork 80Emulation frontend containing static web files used to browse and launch games 4001IPFS peering port, if you want to participate in the P2P network to distribute frontend artwork please forward this to the Internet
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. SUBFOLDER=/Specify a subfolder for reverse proxies IE '/FOLDER/'
Volume Mappings (-v)¶
Volume Function /configPath to store user profiles /dataPath to store roms/artwork
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:
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:
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 emulatorjs /bin/bash- To monitor the logs of the container in realtime:
docker logs -f emulatorjs- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' emulatorjs- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/emulatorjs:latest
Versions¶
- 06.07.23: - Deprecate armhf. As announced here
- 24.11.22: - Update IPFS links for chdman.
- 04.04.22: - Ingest pre-built chdman bins during build time.
- 23.02.22: - Update ingestion point for emulatorjs bins.
- 25.01.22: - Allow users to mount in existing rom directories.
- 14.01.22: - Add profile paths and rebase to Alpine 3.15.
- 04.01.22: - Add headers needed for Threaded emulators.
- 29.11.21: - Add wasm mime type to NGINX.
- 26.11.21: - Configure IPFS in a lower power mode, use homebuilt blobs for emu cores.
- 19.11.21: - Pin retroarch version.
- 14.11.21: - Update default cores to ingest.
- 23.10.21: - Initial release.
\ No newline at end of file
+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 emulatorjs /bin/bash- To monitor the logs of the container in realtime:
docker logs -f emulatorjs- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' emulatorjs- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/emulatorjs:latest
Versions¶
- 06.07.23: - Deprecate armhf. As announced here
- 24.11.22: - Update IPFS links for chdman.
- 04.04.22: - Ingest pre-built chdman bins during build time.
- 23.02.22: - Update ingestion point for emulatorjs bins.
- 25.01.22: - Allow users to mount in existing rom directories.
- 14.01.22: - Add profile paths and rebase to Alpine 3.15.
- 04.01.22: - Add headers needed for Threaded emulators.
- 29.11.21: - Add wasm mime type to NGINX.
- 26.11.21: - Configure IPFS in a lower power mode, use homebuilt blobs for emu cores.
- 19.11.21: - Pin retroarch version.
- 14.11.21: - Update default cores to ingest.
- 23.10.21: - Initial release.
linuxserver/endlessh¶
Endlessh is an SSH tarpit that very slowly sends an endless, random SSH banner. It keeps SSH clients locked up for hours or even days at a time. The purpose is to put your real SSH server on another port and then let the script kiddies get stuck in this tarpit instead of bothering a real server.
Supported Architectures¶
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/endlessh:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
The app listens on the port mapped for ssh connections. To log to file, set the environment variable LOGFILE to true and map a volume for /config. The logs will be under /config/logs/endlessh.
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)¶
---
+ endlessh - LinuxServer.io linuxserver/endlessh¶
Endlessh is an SSH tarpit that very slowly sends an endless, random SSH banner. It keeps SSH clients locked up for hours or even days at a time. The purpose is to put your real SSH server on another port and then let the script kiddies get stuck in this tarpit instead of bothering a real server.
Supported Architectures¶
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/endlessh:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
The app listens on the port mapped for ssh connections. To log to file, set the environment variable LOGFILE to true and map a volume for /config. The logs will be under /config/logs/endlessh.
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)¶
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 2222ssh port
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. MSDELAY=10000The endless banner is sent one line at a time. This is the delay in milliseconds between individual lines. MAXLINES=32The length of each line is randomized. This controls the maximum length of each line. Shorter lines may keep clients on for longer if they give up after a certain number of bytes. MAXCLIENTS=4096Maximum number of connections to accept at a time. Connections beyond this are not immediately rejected, but will wait in the queue. LOGFILE=falseBy default, the app logs to container log. If this is set to true, the log will be output to file under /config/logs/endlessh (/config needs to be mapped). BINDFAMILY=By default, the app binds to IPv4 and IPv6 addresses. Set it to 4 or 6 to bind to IPv4 only or IPv6 only, respectively. Leave blank to bind to both.
Volume Mappings (-v)¶
Volume Function /configRequired if LOGFILE is set to true.
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:
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:
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 endlessh /bin/bash- To monitor the logs of the container in realtime:
docker logs -f endlessh- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' endlessh- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/endlessh:latest
Versions¶
- 12.06.23: - Rebase to Alpine 3.18, deprecate armhf.
- 05.03.23: - Rebase to Alpine 3.17.
- 23.09.22: - Migrate to s6v3.
- 20.07.22: - Rebase to Alpine 3.16.
- 16.04.22: - Rebase to Alpine 3.15.
- 07.10.21: - Fix typo on MAXLINES var.
- 08.06.21: - Add BINDFAMILY option.
- 16.04.21: - Initial Release.
\ No newline at end of file
+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 endlessh /bin/bash- To monitor the logs of the container in realtime:
docker logs -f endlessh- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' endlessh- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/endlessh:latest
Versions¶
- 12.06.23: - Rebase to Alpine 3.18, deprecate armhf.
- 05.03.23: - Rebase to Alpine 3.17.
- 23.09.22: - Migrate to s6v3.
- 20.07.22: - Rebase to Alpine 3.16.
- 16.04.22: - Rebase to Alpine 3.15.
- 07.10.21: - Fix typo on MAXLINES var.
- 08.06.21: - Add BINDFAMILY option.
- 16.04.21: - Initial Release.
linuxserver/fail2ban¶
Fail2ban is a daemon to ban hosts that cause multiple authentication errors.
Supported Architectures¶
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/fail2ban:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
This container is designed to allow fail2ban to function at the host level, as well as at the docker container level. If you are running applications on the host, you will need to set the chain to INPUT in the jail for that application.
Configuration Files¶
On first run, the container will create a number of folders and files in /config. The default configurations for fail2ban are all disabled by default.
Please refer to the Configuration README, which can be viewed in our repository, or in your config folder at /config/fail2ban/README.md.
Remote Logs¶
All jails require the ability to read the application log files. We recommend mounting each application's log folder as a volume to the container (illustrated by the optional volumes in our documentation). Mounting individual log files can cause issues and is not recommended.
The /remotelogs path is designed to act as a parent for all log files you would like fail2ban to be able to use. Each log file should be mounted in a subfolder underneath /remotelogs, ex: - /remotelogs/nginx/ would mount a folder containing the nginx logs to the container
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)¶
---
+ fail2ban - LinuxServer.io linuxserver/fail2ban¶
Fail2ban is a daemon to ban hosts that cause multiple authentication errors.
Supported Architectures¶
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/fail2ban:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
This container is designed to allow fail2ban to function at the host level, as well as at the docker container level. If you are running applications on the host, you will need to set the chain to INPUT in the jail for that application.
Configuration Files¶
On first run, the container will create a number of folders and files in /config. The default configurations for fail2ban are all disabled by default.
Please refer to the Configuration README, which can be viewed in our repository, or in your config folder at /config/fail2ban/README.md.
Remote Logs¶
All jails require the ability to read the application log files. We recommend mounting each application's log folder as a volume to the container (illustrated by the optional volumes in our documentation). Mounting individual log files can cause issues and is not recommended.
The /remotelogs path is designed to act as a parent for all log files you would like fail2ban to be able to use. Each log file should be mounted in a subfolder underneath /remotelogs, ex: - /remotelogs/nginx/ would mount a folder containing the nginx logs to the container
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)¶
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
Networking (--net)¶
Parameter Function --net=hostShares host networking with container.
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. VERBOSITY=-vvSet the container log verbosity. Valid options are -v, -vv, -vvv, -vvvv, or leaving the value blank or not setting the variable.
Volume Mappings (-v)¶
Volume Function /configContains all relevant configuration files. /var/log:roHost logs. Mounted as Read Only. /remotelogs/airsonic:roOptional path to airsonic log folder. Mounted as Read Only. /remotelogs/apache2:roOptional path to apache2 log folder. Mounted as Read Only. /remotelogs/authelia:roOptional path to authelia log folder. Mounted as Read Only. /remotelogs/emby:roOptional path to emby log folder. Mounted as Read Only. /remotelogs/filebrowser:roOptional path to filebrowser log folder. Mounted as Read Only. /remotelogs/homeassistant:roOptional path to homeassistant log folder. Mounted as Read Only. /remotelogs/lighttpd:roOptional path to lighttpd log folder. Mounted as Read Only. /remotelogs/nextcloud:roOptional path to nextcloud log folder. Mounted as Read Only. /remotelogs/nginx:roOptional path to nginx log folder. Mounted as Read Only. /remotelogs/nzbget:roOptional path to nzbget log folder. Mounted as Read Only. /remotelogs/overseerr:roOptional path to overseerr log folder. Mounted as Read Only. /remotelogs/prowlarr:roOptional path to prowlarr log folder. Mounted as Read Only. /remotelogs/radarr:roOptional path to radarr log folder. Mounted as Read Only. /remotelogs/sabnzbd:roOptional path to sabnzbd log folder. Mounted as Read Only. /remotelogs/sonarr:roOptional path to sonarr log folder. Mounted as Read Only. /remotelogs/unificontroller:roOptional path to unificontroller log folder. Mounted as Read Only. /remotelogs/vaultwarden:roOptional path to vaultwarden log folder. Mounted as Read Only.
Miscellaneous Options¶
Parameter Function
Portainer notice¶
{% hint style="warning" %} This image utilises cap_add or sysctl to work properly. This is not implemented properly in some versions of Portainer, thus this image may not work if deployed through Portainer.
Environment variables from files (Docker secrets)¶
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
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:
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 fail2ban /bin/bash- To monitor the logs of the container in realtime:
docker logs -f fail2ban- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' fail2ban- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/fail2ban:latest
Versions¶
- 01.06.23: - Add optional VERBOSITY environment variable, allowing users to set the container log verbosity.
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 15.12.22: - Replace unmaintained ssmtp with msmtp.
- 15.12.22: - Rebase to Alpine 3.17, Add ssmtp and whois packages. Symlink config to allow live reloading.
- 25.08.22: - Update README to clarify remote log information.
- 09.08.22: - Initial Release.
\ No newline at end of file
+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 fail2ban /bin/bash- To monitor the logs of the container in realtime:
docker logs -f fail2ban- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' fail2ban- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/fail2ban:latest
Versions¶
- 01.06.23: - Add optional VERBOSITY environment variable, allowing users to set the container log verbosity.
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 15.12.22: - Replace unmaintained ssmtp with msmtp.
- 15.12.22: - Rebase to Alpine 3.17, Add ssmtp and whois packages. Symlink config to allow live reloading.
- 25.08.22: - Update README to clarify remote log information.
- 09.08.22: - Initial Release.
linuxserver/feed2toot¶
Feed2toot automatically parses rss feeds, identifies new posts and posts them on the Mastodon social network.
Supported Architectures¶
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/feed2toot:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
Run docker run --rm -it -w /config -v /path/to/data:/config -e PUID=1000 -e PGID=1000 lscr.io/linuxserver/feed2toot /lsiopy/bin/register_feed2toot_app to generate credential files (be sure to set the correct volume path and PUID/PGID values).
Edit the feed2toot.ini in /config to configure your instance name and RSS feeds.
See the feed2toot docs for more information.
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)¶
---
+ feed2toot - LinuxServer.io linuxserver/feed2toot¶
Feed2toot automatically parses rss feeds, identifies new posts and posts them on the Mastodon social network.
Supported Architectures¶
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/feed2toot:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
Run docker run --rm -it -w /config -v /path/to/data:/config -e PUID=1000 -e PGID=1000 lscr.io/linuxserver/feed2toot /lsiopy/bin/register_feed2toot_app to generate credential files (be sure to set the correct volume path and PUID/PGID values).
Edit the feed2toot.ini in /config to configure your instance name and RSS feeds.
See the feed2toot docs for more information.
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)¶
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
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. FEED_LIMIT=5Limit number of RSS entries published at each execution.
Volume Mappings (-v)¶
Volume Function /configLocal path for feed2toot config files.
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:
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:
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 feed2toot /bin/bash- To monitor the logs of the container in realtime:
docker logs -f feed2toot- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' feed2toot- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/feed2toot:latest
Versions¶
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 02.03.23: - Allow user customizable cron.
- 22.12.22: - Rebase to alpine 3.17.
- 14.11.22: - Initial Release.
\ No newline at end of file
+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 feed2toot /bin/bash- To monitor the logs of the container in realtime:
docker logs -f feed2toot- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' feed2toot- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/feed2toot:latest
Versions¶
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 02.03.23: - Allow user customizable cron.
- 22.12.22: - Rebase to alpine 3.17.
- 14.11.22: - Initial Release.
ffmpeg
The LinuxServer.io team brings you another container release featuring :-
- regular and timely application updates
- easy user mappings (PGID, PUID)
- custom base image with s6 overlay
- weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
- regular security updates
Find us at: * Blog - all the things you can do with our containers including How-To guides, opinions and much more! * Discord - realtime support / chat with the community and the team. * Discourse - post on our community forum. * Fleet - an online web interface which displays all of our maintained images. * Open Collective - please consider helping us by either donating or contributing to our budget
FFmpeg - A complete, cross-platform solution to record, convert and stream audio and video.
Supported Architectures¶
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/ffmpeg:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ | arm32v7-<version tag> |
Usage¶
Unlike most of our container library this image is meant to be run ephemerally from the command line parsing user input for a custom FFmpeg command. You will need to understand some Docker basics to use this image and be familiar with how to construct an FFmpeg command. In the commands below we will be bind mounting our current working directory from the CLI to /config, the assumption is that input.mkv is in your current working directory.
If an input file is detected we will run FFmpeg as that user/group so the output file will match its permissions. The image supports Hardware acceleration on x86 pay close attention to the variables for the examples below.
Included Intel Drivers (latest versions compiled):¶
- iHD Driver: Supports gen8+ (default for Intel)
- i965 Driver: Supports gen5+ (for gen5-gen9.5 it can be enabled by setting env var
LIBVA_DRIVER_NAME=i965in docker arguments) - Libva (VAAPI): Supports gen5+ with i965 driver and gen8+ with iHD driver
- Qsv Dispatcher: OneVPL (supports both OneVPL and MSDK runtimes and should automatically switch)
- Qsv Runtime:
- OneVPL: Supports gen12+
- MSDK (libmfx): Supports gen8 - gen12
Basic Transcode¶
docker run --rm -it \
+ ffmpeg - LinuxServer.io ffmpeg
The LinuxServer.io team brings you another container release featuring :-
- regular and timely application updates
- easy user mappings (PGID, PUID)
- custom base image with s6 overlay
- weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
- regular security updates
Find us at: * Blog - all the things you can do with our containers including How-To guides, opinions and much more! * Discord - realtime support / chat with the community and the team. * Discourse - post on our community forum. * Fleet - an online web interface which displays all of our maintained images. * Open Collective - please consider helping us by either donating or contributing to our budget
FFmpeg - A complete, cross-platform solution to record, convert and stream audio and video.
Supported Architectures¶
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/ffmpeg:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌ arm32v7-<version tag>
Usage¶
Unlike most of our container library this image is meant to be run ephemerally from the command line parsing user input for a custom FFmpeg command. You will need to understand some Docker basics to use this image and be familiar with how to construct an FFmpeg command. In the commands below we will be bind mounting our current working directory from the CLI to /config, the assumption is that input.mkv is in your current working directory.
If an input file is detected we will run FFmpeg as that user/group so the output file will match its permissions. The image supports Hardware acceleration on x86 pay close attention to the variables for the examples below.
Included Intel Drivers (latest versions compiled):¶
- iHD Driver: Supports gen8+ (default for Intel)
- i965 Driver: Supports gen5+ (for gen5-gen9.5 it can be enabled by setting env var
LIBVA_DRIVER_NAME=i965 in docker arguments) - Libva (VAAPI): Supports gen5+ with i965 driver and gen8+ with iHD driver
- Qsv Dispatcher: OneVPL (supports both OneVPL and MSDK runtimes and should automatically switch)
- Qsv Runtime:
- OneVPL: Supports gen12+
- MSDK (libmfx): Supports gen8 - gen12
Basic Transcode¶
docker run --rm -it \
-v $(pwd):/config \
linuxserver/ffmpeg \
-i /config/input.mkv \
@@ -46,4 +46,4 @@
--pull \
-t linuxserver/ffmpeg:latest .
The ARM variants can be built on x86_64 hardware using multiarch/qemu-user-static
Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.
Versions¶
- 16.08.23: - Added support for WebP formats.
- 11.08.23: - Add optional i965 driver for gen5+ support.
- 14.06.23: - Switch to latest iHD for Intel, add qsv support.
- 13.06.23: - Bump to 6.0, update shared libraries, deprecate armhf, combine bin stage.
- 14.12.22: - Rebase to Jammy, bump to 5.1.2.
- 19.06.22: - Rebase to Focal.
- 26.08.21: - Add support for libOpenCL.
- 01.07.21: - Bump to 4.4.
- 17.06.20: - Bump to 4.3.
- 16.06.20: - Add support for libvmaf.
- 01.08.19: - Initial release.
\ No newline at end of file
+Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.
Versions¶
- 16.08.23: - Added support for WebP formats.
- 11.08.23: - Add optional i965 driver for gen5+ support.
- 14.06.23: - Switch to latest iHD for Intel, add qsv support.
- 13.06.23: - Bump to 6.0, update shared libraries, deprecate armhf, combine bin stage.
- 14.12.22: - Rebase to Jammy, bump to 5.1.2.
- 19.06.22: - Rebase to Focal.
- 26.08.21: - Add support for libOpenCL.
- 01.07.21: - Bump to 4.4.
- 17.06.20: - Bump to 4.3.
- 16.06.20: - Add support for libvmaf.
- 01.08.19: - Initial release.
linuxserver/filezilla¶
FIleZilla Client is a fast and reliable cross-platform FTP, FTPS and SFTP client with lots of useful features and an intuitive graphical user interface.
Supported Architectures¶
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/filezilla:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
The application can be accessed at:
- http://yourhost:3000/
- https://yourhost:3001/
Options in all KasmVNC based GUI containers¶
This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.
Optional environment variables¶
| Variable | Description |
|---|---|
| CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default 3000. |
| CUSTOM_HTTPS_PORT | Internal port the container listens on for https if it needs to be swapped from the default 3001. |
| CUSTOM_USER | HTTP Basic auth username, abc is default. |
| PASSWORD | HTTP Basic auth password, abc is default. If unset there will be no auth |
| SUBFOLDER | Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/ |
| TITLE | The page title displayed on the web browser, default "KasmVNC Client". |
| FM_HOME | This is the home directory (landing) for the file manager, default "/config". |
| START_DOCKER | If set to false a container with privilege will not automatically start the DinD Docker setup. |
| DRINODE | If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE /dev/dri/renderD128 |
Optional run configurations¶
| Variable | Description |
|---|---|
--privileged | Will start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE -v /home/user/docker-data:/var/lib/docker. |
-v /var/run/docker.sock:/var/run/docker.sock | Mount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. |
--device /dev/dri:/dev/dri | Mount a GPU into the container, this can be used in conjunction with the DRINODE environment variable to leverage a host video card for GPU accelerated appplications. Only Open Source drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau) |
Lossless mode¶
This container is capable of delivering a true lossless image at a high framerate to your web browser by changing the Stream Quality preset to "Lossless", more information here. In order to use this mode from a non localhost endpoint the HTTPS port on 3001 needs to be used. If using a reverse proxy to port 3000 specific headers will need to be set as outlined here.
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)¶
---
+ filezilla - LinuxServer.io linuxserver/filezilla¶
FIleZilla Client is a fast and reliable cross-platform FTP, FTPS and SFTP client with lots of useful features and an intuitive graphical user interface.
Supported Architectures¶
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/filezilla:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
The application can be accessed at:
- http://yourhost:3000/
- https://yourhost:3001/
Options in all KasmVNC based GUI containers¶
This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.
Optional environment variables¶
Variable Description CUSTOM_PORT Internal port the container listens on for http if it needs to be swapped from the default 3000. CUSTOM_HTTPS_PORT Internal port the container listens on for https if it needs to be swapped from the default 3001. CUSTOM_USER HTTP Basic auth username, abc is default. PASSWORD HTTP Basic auth password, abc is default. If unset there will be no auth SUBFOLDER Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/ TITLE The page title displayed on the web browser, default "KasmVNC Client". FM_HOME This is the home directory (landing) for the file manager, default "/config". START_DOCKER If set to false a container with privilege will not automatically start the DinD Docker setup. DRINODE If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE /dev/dri/renderD128
Optional run configurations¶
Variable Description --privilegedWill start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE -v /home/user/docker-data:/var/lib/docker. -v /var/run/docker.sock:/var/run/docker.sockMount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. --device /dev/dri:/dev/driMount a GPU into the container, this can be used in conjunction with the DRINODE environment variable to leverage a host video card for GPU accelerated appplications. Only Open Source drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau)
Lossless mode¶
This container is capable of delivering a true lossless image at a high framerate to your web browser by changing the Stream Quality preset to "Lossless", more information here. In order to use this mode from a non localhost endpoint the HTTPS port on 3001 needs to be used. If using a reverse proxy to port 3000 specific headers will need to be set as outlined here.
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)¶
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 3000FileZilla desktop gui. 3001FileZilla desktop gui HTTPS.
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configUsers home directory in the container, stores local files and settings
Miscellaneous Options¶
Parameter Function --security-opt seccomp=unconfinedFor Docker Engine only, many modern gui apps need this to function on older hosts as syscalls are unknown to Docker.
Environment variables from files (Docker secrets)¶
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
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:
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 filezilla /bin/bash- To monitor the logs of the container in realtime:
docker logs -f filezilla- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' filezilla- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/filezilla:latest
Versions¶
- 03.07.23: - Deprecate armhf. As announced here
- 13.05.23: - Rebase to Alpine 3.18.
- 18.03.23: - Rebase to KasmVNC base image.
- 21.10.22: - Rebase to Alpine 3.16, migrate to s6v3.
- 23.12.21: - Rebase to Alpine 3.15.
- 26.09.21: - Rebase to Alpine 3.14.
- 18.04.21: - Initial release.
\ No newline at end of file
+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 filezilla /bin/bash- To monitor the logs of the container in realtime:
docker logs -f filezilla- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' filezilla- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/filezilla:latest
Versions¶
- 03.07.23: - Deprecate armhf. As announced here
- 13.05.23: - Rebase to Alpine 3.18.
- 18.03.23: - Rebase to KasmVNC base image.
- 21.10.22: - Rebase to Alpine 3.16, migrate to s6v3.
- 23.12.21: - Rebase to Alpine 3.15.
- 26.09.21: - Rebase to Alpine 3.14.
- 18.04.21: - Initial release.
linuxserver/firefox¶
Firefox Browser, also known as Mozilla Firefox or simply Firefox, is a free and open-source web browser developed by the Mozilla Foundation and its subsidiary, the Mozilla Corporation. Firefox uses the Gecko layout engine to render web pages, which implements current and anticipated web standards.
Supported Architectures¶
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/firefox:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
The application can be accessed at:
- http://yourhost:3000/
- https://yourhost:3001/
Options in all KasmVNC based GUI containers¶
This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.
Optional environment variables¶
| Variable | Description |
|---|---|
| CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default 3000. |
| CUSTOM_HTTPS_PORT | Internal port the container listens on for https if it needs to be swapped from the default 3001. |
| CUSTOM_USER | HTTP Basic auth username, abc is default. |
| PASSWORD | HTTP Basic auth password, abc is default. If unset there will be no auth |
| SUBFOLDER | Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/ |
| TITLE | The page title displayed on the web browser, default "KasmVNC Client". |
| FM_HOME | This is the home directory (landing) for the file manager, default "/config". |
| START_DOCKER | If set to false a container with privilege will not automatically start the DinD Docker setup. |
| DRINODE | If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE /dev/dri/renderD128 |
Optional run configurations¶
| Variable | Description |
|---|---|
--privileged | Will start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE -v /home/user/docker-data:/var/lib/docker. |
-v /var/run/docker.sock:/var/run/docker.sock | Mount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. |
--device /dev/dri:/dev/dri | Mount a GPU into the container, this can be used in conjunction with the DRINODE environment variable to leverage a host video card for GPU accelerated appplications. Only Open Source drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau) |
Lossless mode¶
This container is capable of delivering a true lossless image at a high framerate to your web browser by changing the Stream Quality preset to "Lossless", more information here. In order to use this mode from a non localhost endpoint the HTTPS port on 3001 needs to be used. If using a reverse proxy to port 3000 specific headers will need to be set as outlined here.
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)¶
---
+ firefox - LinuxServer.io linuxserver/firefox¶
Firefox Browser, also known as Mozilla Firefox or simply Firefox, is a free and open-source web browser developed by the Mozilla Foundation and its subsidiary, the Mozilla Corporation. Firefox uses the Gecko layout engine to render web pages, which implements current and anticipated web standards.
Supported Architectures¶
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/firefox:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
The application can be accessed at:
- http://yourhost:3000/
- https://yourhost:3001/
Options in all KasmVNC based GUI containers¶
This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.
Optional environment variables¶
Variable Description CUSTOM_PORT Internal port the container listens on for http if it needs to be swapped from the default 3000. CUSTOM_HTTPS_PORT Internal port the container listens on for https if it needs to be swapped from the default 3001. CUSTOM_USER HTTP Basic auth username, abc is default. PASSWORD HTTP Basic auth password, abc is default. If unset there will be no auth SUBFOLDER Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/ TITLE The page title displayed on the web browser, default "KasmVNC Client". FM_HOME This is the home directory (landing) for the file manager, default "/config". START_DOCKER If set to false a container with privilege will not automatically start the DinD Docker setup. DRINODE If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE /dev/dri/renderD128
Optional run configurations¶
Variable Description --privilegedWill start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE -v /home/user/docker-data:/var/lib/docker. -v /var/run/docker.sock:/var/run/docker.sockMount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. --device /dev/dri:/dev/driMount a GPU into the container, this can be used in conjunction with the DRINODE environment variable to leverage a host video card for GPU accelerated appplications. Only Open Source drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau)
Lossless mode¶
This container is capable of delivering a true lossless image at a high framerate to your web browser by changing the Stream Quality preset to "Lossless", more information here. In order to use this mode from a non localhost endpoint the HTTPS port on 3001 needs to be used. If using a reverse proxy to port 3000 specific headers will need to be set as outlined here.
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)¶
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 3000Firefox desktop gui. 3001Firefox desktop gui HTTPS.
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configUsers home directory in the container, stores local files and settings
Miscellaneous Options¶
Parameter Function --shm-size=This is needed for any modern website to function like youtube. --security-opt seccomp=unconfinedFor Docker Engine only, many modern gui apps need this to function on older hosts as syscalls are unknown to Docker.
Environment variables from files (Docker secrets)¶
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
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:
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 firefox /bin/bash- To monitor the logs of the container in realtime:
docker logs -f firefox- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' firefox- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/firefox:latest
Versions¶
- 13.05.23: - Rebase to Alpine 3.18.
- 18.03.23: - Rebase to KasmVNC base image.
- 21.10.22: - Rebase to Alpine 3.16, migrate to s6v3.
- 23.12.21: - Rebase to Alpine 3.15, stop using ESR.
- 26.09.21: - Rebase to Alpine 3.14.
- 19.04.21: - Initial release.
\ No newline at end of file
+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 firefox /bin/bash- To monitor the logs of the container in realtime:
docker logs -f firefox- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' firefox- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/firefox:latest
Versions¶
- 13.05.23: - Rebase to Alpine 3.18.
- 18.03.23: - Rebase to KasmVNC base image.
- 21.10.22: - Rebase to Alpine 3.16, migrate to s6v3.
- 23.12.21: - Rebase to Alpine 3.15, stop using ESR.
- 26.09.21: - Rebase to Alpine 3.14.
- 19.04.21: - Initial release.
linuxserver/fleet¶
Fleet provides an online web interface which displays a set of maintained images from one or more owned repositories.
Supported Architectures¶
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/fleet:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
Navigate to http://your_ip_here:8080 to display the home page. If DATABASE is selected as the preferred authentication process, ensure that you set up an initial user via http://your_ip_here:8080/setup. Once done, that page will no longer be available. A restart is preferable as it will remove the page altogether. Once complete, you can log into the app via http://your_ip_here:8080/login to manage your repositories.
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)¶
---
+ fleet - LinuxServer.io linuxserver/fleet¶
Fleet provides an online web interface which displays a set of maintained images from one or more owned repositories.
Supported Architectures¶
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/fleet:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
Navigate to http://your_ip_here:8080 to display the home page. If DATABASE is selected as the preferred authentication process, ensure that you set up an initial user via http://your_ip_here:8080/setup. Once done, that page will no longer be available. A restart is preferable as it will remove the page altogether. Once complete, you can log into the app via http://your_ip_here:8080/login to manage your repositories.
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)¶
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 8080Http port
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. fleet_admin_authentication_type=DATABASEA switch to define how Fleet manages user logins. If set to DATABASE, see the related optional params. Can be set to either DATABASE or PROPERTIES. fleet_database_url=jdbc:mariadb://<url>:3306/fleetThe full JDBC connection string to the Fleet database fleet_database_username=fleet_userThe username with the relevant GRANT permissions for the database fleet_database_password=dbuserpasswordThe database user's password. fleet_admin_secret=randomstringA string used as part of the password key derivation process.
Volume Mappings (-v)¶
Volume Function /configThe primary config file and rolling log files.
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:
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:
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 fleet /bin/bash- To monitor the logs of the container in realtime:
docker logs -f fleet- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' fleet- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/fleet:latest
Versions¶
- 12.07.23: - Rebase to Alpine 3.18.
- 13.02.23: - Rebase to Alpine 3.17, migrate to s6v3.
- 02.05.22: - Rebase to Alpine 3.15.
- 13.12.21: - Add mitigations for CVE-2021-44228
- 26.04.20: - Updated to keep in line with v2.0.0 branch of Fleet
- 19.12.19: - Rebasing to alpine 3.11.
- 02.07.19: - Rebasing to alpine 3.10.
- 02.07.19: - Stop container if fleet fails.
- 19.05.19: - Use new base images for arm versions.
- 01.04.19: - Initial Release
\ No newline at end of file
+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 fleet /bin/bash- To monitor the logs of the container in realtime:
docker logs -f fleet- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' fleet- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/fleet:latest
Versions¶
- 12.07.23: - Rebase to Alpine 3.18.
- 13.02.23: - Rebase to Alpine 3.17, migrate to s6v3.
- 02.05.22: - Rebase to Alpine 3.15.
- 13.12.21: - Add mitigations for CVE-2021-44228
- 26.04.20: - Updated to keep in line with v2.0.0 branch of Fleet
- 19.12.19: - Rebasing to alpine 3.11.
- 02.07.19: - Rebasing to alpine 3.10.
- 02.07.19: - Stop container if fleet fails.
- 19.05.19: - Use new base images for arm versions.
- 01.04.19: - Initial Release
linuxserver/flexget¶
Flexget is a multipurpose automation tool for all of your media.
Supported Architectures¶
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/flexget:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
Default config file is /config/.flexget
See the FlexGet website for more information.
Download folders¶
We have set /data as an optional path, this is because it is the easiest way to get started. While easy to use, it has some drawbacks. Mainly losing the ability to hardlink (TL;DR a way for a file to exist in multiple places on the same file system while only consuming one file worth of space), or atomic move (TL;DR instant file moves, rather than copy+delete) files while processing content.
Use the optional paths if you dont understand, or dont want hardlinks/atomic moves.
The folks over at servarr.com wrote a good write-up on how to get started with this.
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)¶
---
+ flexget - LinuxServer.io linuxserver/flexget¶
Flexget is a multipurpose automation tool for all of your media.
Supported Architectures¶
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/flexget:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
Default config file is /config/.flexget
See the FlexGet website for more information.
Download folders¶
We have set /data as an optional path, this is because it is the easiest way to get started. While easy to use, it has some drawbacks. Mainly losing the ability to hardlink (TL;DR a way for a file to exist in multiple places on the same file system while only consuming one file worth of space), or atomic move (TL;DR instant file moves, rather than copy+delete) files while processing content.
Use the optional paths if you dont understand, or dont want hardlinks/atomic moves.
The folks over at servarr.com wrote a good write-up on how to get started with this.
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)¶
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 5050HTTP port for the WebUI.
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. FG_LOG_LEVEL=infoSet the FlexGet logging level. FG_LOG_FILE=/config/flexget.logSet the FlexGet log file location. FG_CONFIG_FILE=/config/.flexget/config.ymlSet the FlexGet config file location. FG_WEBUI_PASSWORD=infoSet the FlexGet webui password. Pay attention to Bash/YAML reserved characters.
Volume Mappings (-v)¶
Volume Function /configLocal path for FlexGet config files. /dataDefault path for downloads.
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:
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:
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 flexget /bin/bash- To monitor the logs of the container in realtime:
docker logs -f flexget- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' flexget- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/flexget:latest
Versions¶
- 10.08.23: - Bump unrar to 6.2.10.
- 03.07.23: - Initial Release.
\ No newline at end of file
+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 flexget /bin/bash- To monitor the logs of the container in realtime:
docker logs -f flexget- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' flexget- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/flexget:latest
Versions¶
- 10.08.23: - Bump unrar to 6.2.10.
- 03.07.23: - Initial Release.
linuxserver/foldingathome¶
Folding@home is a distributed computing project for simulating protein dynamics, including the process of protein folding and the movements of proteins implicated in a variety of diseases. It brings together citizen scientists who volunteer to run simulations of protein dynamics on their personal computers. Insights from this data are helping scientists to better understand biology, and providing new opportunities for developing therapeutics.
Supported Architectures¶
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/foldingathome:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
This image sets up the Folding@home client. The interface is available at http://your-ip:7396.
The built-in webserver provides very basic control (ie. GPUs are only active when set to Medium or higher). For more fine grained control of individual devices, you can use the FAHControl app on a different device and connect remotely via port 36330 (no password).
There are a couple of minor issues with the webgui: - If you get an "ERR_EMPTY_RESPONSE" error when trying to access via IP, it's most likely due to a clash of cookies/cache. Try opening in an incgnito window. - If you're getting a constant refresh of the window but no display of info, try a force refresh via shft-F5 or ctrl-F5.
GPU Hardware Acceleration¶
Nvidia¶
Hardware acceleration users for Nvidia will need to install the container runtime provided by Nvidia on their host, instructions can be found here: https://github.com/NVIDIA/nvidia-docker We automatically add the necessary environment variable that will utilise all the features available on a GPU on the host. Once nvidia-docker is installed on your host you will need to re/create the docker container with the nvidia container runtime --runtime=nvidia and add an environment variable -e NVIDIA_VISIBLE_DEVICES=all (can also be set to a specific gpu's UUID, this can be discovered by running nvidia-smi --query-gpu=gpu_name,gpu_uuid --format=csv ). NVIDIA automatically mounts the GPU and drivers from your host into the foldingathome docker container.
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)¶
---
+ foldingathome - LinuxServer.io linuxserver/foldingathome¶
Folding@home is a distributed computing project for simulating protein dynamics, including the process of protein folding and the movements of proteins implicated in a variety of diseases. It brings together citizen scientists who volunteer to run simulations of protein dynamics on their personal computers. Insights from this data are helping scientists to better understand biology, and providing new opportunities for developing therapeutics.
Supported Architectures¶
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/foldingathome:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
This image sets up the Folding@home client. The interface is available at http://your-ip:7396.
The built-in webserver provides very basic control (ie. GPUs are only active when set to Medium or higher). For more fine grained control of individual devices, you can use the FAHControl app on a different device and connect remotely via port 36330 (no password).
There are a couple of minor issues with the webgui: - If you get an "ERR_EMPTY_RESPONSE" error when trying to access via IP, it's most likely due to a clash of cookies/cache. Try opening in an incgnito window. - If you're getting a constant refresh of the window but no display of info, try a force refresh via shft-F5 or ctrl-F5.
GPU Hardware Acceleration¶
Nvidia¶
Hardware acceleration users for Nvidia will need to install the container runtime provided by Nvidia on their host, instructions can be found here: https://github.com/NVIDIA/nvidia-docker We automatically add the necessary environment variable that will utilise all the features available on a GPU on the host. Once nvidia-docker is installed on your host you will need to re/create the docker container with the nvidia container runtime --runtime=nvidia and add an environment variable -e NVIDIA_VISIBLE_DEVICES=all (can also be set to a specific gpu's UUID, this can be discovered by running nvidia-smi --query-gpu=gpu_name,gpu_uuid --format=csv ). NVIDIA automatically mounts the GPU and drivers from your host into the foldingathome docker container.
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)¶
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 7396Folding@home web gui. 36330Optional port for connecting remotely via FAHControl app (no password).
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configWhere Folding@home should store its database and config.
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:
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:
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 foldingathome /bin/bash- To monitor the logs of the container in realtime:
docker logs -f foldingathome- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' foldingathome- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/foldingathome:latest
Versions¶
- 14.12.22: - Rebase to Ubuntu Jammy, migrate to s6v3.
- 15.01.22: - Rebase to Ubuntu Focal. Add arm64v8 builds (cpu only). Increase verbosity about gpu driver permission settings.
- 09.01.21: - Add nvidia.icd.
- 14.04.20: - Add Folding@home donation links.
- 20.03.20: - Initial release.
\ No newline at end of file
+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 foldingathome /bin/bash- To monitor the logs of the container in realtime:
docker logs -f foldingathome- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' foldingathome- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/foldingathome:latest
Versions¶
- 14.12.22: - Rebase to Ubuntu Jammy, migrate to s6v3.
- 15.01.22: - Rebase to Ubuntu Focal. Add arm64v8 builds (cpu only). Increase verbosity about gpu driver permission settings.
- 09.01.21: - Add nvidia.icd.
- 14.04.20: - Add Folding@home donation links.
- 20.03.20: - Initial release.
linuxserver/freshrss¶
Freshrss is a free, self-hostable aggregator for rss feeds.
Supported Architectures¶
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/freshrss:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
Access the webui set up wizard at http://serverIP:port
For external databases, create a user and database in your mysql/mariadb server (not root) and then follow the setup wizard in the webui. Use the IP address for "host" of your database server.
Additional extensions can be dropped into /config/www/freshrss/extensions and will be active after container restart.
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)¶
---
+ freshrss - LinuxServer.io linuxserver/freshrss¶
Freshrss is a free, self-hostable aggregator for rss feeds.
Supported Architectures¶
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/freshrss:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
Access the webui set up wizard at http://serverIP:port
For external databases, create a user and database in your mysql/mariadb server (not root) and then follow the setup wizard in the webui. Use the IP address for "host" of your database server.
Additional extensions can be dropped into /config/www/freshrss/extensions and will be active after container restart.
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)¶
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 80WebUI
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configLocal storage for freshrss site files.
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:
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:
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 freshrss /bin/bash- To monitor the logs of the container in realtime:
docker logs -f freshrss- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' freshrss- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/freshrss:latest
Versions¶
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 13.04.23: - Move ssl.conf include to default.conf.
- 02.03.23: - Split cron into separate init step and set crontab permissions.
- 19.01.23: - Rebase to alpine 3.17 with php8.1.
- 21.10.22: - Fix cron init to properly migrate existing installations to new app location.
- 20.08.22: - Rebasing to alpine 3.15 with php8. Restructure nginx configs (see changes announcement).
- 23.01.21: - Rebasing to alpine 3.13.
- 01.06.20: - Rebasing to alpine 3.12.
- 31.03.20: - Internalize app and enable updates for existing users, allow user customized crontab.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebasing to alpine 3.9.
- 14.01.19: - Add multi arch and pipeline logic.
- 05.09.18: - Rebase to alpine linux 3.8.
- 17.03.18: - Update nginx config to resolve api not working.
- 08.01.18: - Rebase to alpine linux 3.7.
- 25.05.17: - Rebase to alpine linux 3.6.
- 23.02.17: - Rebase to alpine linux 3.5 and nginx.
- 14.10.16: - Add version layer information.
- 08.10.16: - Add Sqlite support for standalone operation.
- 27.09.16: - Fix for cron job.
- 11.09.16: - Add layer badges to README.
- 23.11.15: - Update dependencies to latest requirements.
- 21.08.15: - Initial Release.
\ No newline at end of file
+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 freshrss /bin/bash- To monitor the logs of the container in realtime:
docker logs -f freshrss- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' freshrss- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/freshrss:latest
Versions¶
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 13.04.23: - Move ssl.conf include to default.conf.
- 02.03.23: - Split cron into separate init step and set crontab permissions.
- 19.01.23: - Rebase to alpine 3.17 with php8.1.
- 21.10.22: - Fix cron init to properly migrate existing installations to new app location.
- 20.08.22: - Rebasing to alpine 3.15 with php8. Restructure nginx configs (see changes announcement).
- 23.01.21: - Rebasing to alpine 3.13.
- 01.06.20: - Rebasing to alpine 3.12.
- 31.03.20: - Internalize app and enable updates for existing users, allow user customized crontab.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebasing to alpine 3.9.
- 14.01.19: - Add multi arch and pipeline logic.
- 05.09.18: - Rebase to alpine linux 3.8.
- 17.03.18: - Update nginx config to resolve api not working.
- 08.01.18: - Rebase to alpine linux 3.7.
- 25.05.17: - Rebase to alpine linux 3.6.
- 23.02.17: - Rebase to alpine linux 3.5 and nginx.
- 14.10.16: - Add version layer information.
- 08.10.16: - Add Sqlite support for standalone operation.
- 27.09.16: - Fix for cron job.
- 11.09.16: - Add layer badges to README.
- 23.11.15: - Update dependencies to latest requirements.
- 21.08.15: - Initial Release.
DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated.
linuxserver/gazee¶
Gazee is a WebApp Comic Reader for your favorite digital comics. Reach and read your comic library from any web connected device with a modern web browser.
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 linuxserver/gazee 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 | amd64-latest |
| arm64 | arm64v8-latest |
| armhf | arm32v6-latest |
Usage¶
Here are some example snippets to help you get started creating a container from this image.
docker¶
docker create \
+ gazee - LinuxServer.io DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated.
linuxserver/gazee¶
Gazee is a WebApp Comic Reader for your favorite digital comics. Reach and read your comic library from any web connected device with a modern web browser.
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 linuxserver/gazee 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 amd64-latest arm64 arm64v8-latest armhf arm32v6-latest
Usage¶
Here are some example snippets to help you get started creating a container from this image.
docker¶
docker create \
--name=gazee \
-e PUID=1000 \
-e PGID=1000 \
@@ -28,4 +28,4 @@
restart: unless-stopped
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 4242WebUI
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation
Volume Mappings (-v)¶
Volume Function /configWhere Gazee should store config files. /comicsPath to comics folder. /mylarPath to Mylar DB. /certsWhere SSL certs should be stored.
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:
Application Setup¶
Webui can be found at your-ip:4242
Default username and password for the web interface:
- Username:
admin - Password:
gazee
Click the gear icon to go to the settings page.
Change the default admin password or add a new admin and remove the admin user altogether.
Comic path should be set to /comics
Optional Mylar DB path should be set to /mylar
Optional path for certificates and keys should be set to /certs
After you update the settings, Gazee will restart and begin an intial scan of your comic library.
Happy Reading!
Support Info¶
- Shell access whilst the container is running:
docker exec -it gazee /bin/bash- To monitor the logs of the container in realtime:
docker logs -f gazee- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' gazee- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/gazee
Versions¶
- 27.03.19: - Deprecate image and get in semi working state.
- 11.02.19: - Add pipeline logic and multi arch.
- 17.08.18: - Rebase to alpine 3.8.
- 30.12.17: - Ensure version 11 of cherrypy.
- 07.12.17: - Initial Release.
\ No newline at end of file
+Application Setup¶
Webui can be found at your-ip:4242
Default username and password for the web interface:
- Username:
admin - Password:
gazee
Click the gear icon to go to the settings page.
Change the default admin password or add a new admin and remove the admin user altogether.
Comic path should be set to /comics
Optional Mylar DB path should be set to /mylar
Optional path for certificates and keys should be set to /certs
After you update the settings, Gazee will restart and begin an intial scan of your comic library.
Happy Reading!
Support Info¶
- Shell access whilst the container is running:
docker exec -it gazee /bin/bash- To monitor the logs of the container in realtime:
docker logs -f gazee- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' gazee- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/gazee
Versions¶
- 27.03.19: - Deprecate image and get in semi working state.
- 11.02.19: - Add pipeline logic and multi arch.
- 17.08.18: - Rebase to alpine 3.8.
- 30.12.17: - Ensure version 11 of cherrypy.
- 07.12.17: - Initial Release.
linuxserver/github-desktop¶
Github Desktop is an open source Electron-based GitHub app. It is written in TypeScript and uses React.
Supported Architectures¶
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/github-desktop:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
The application can be accessed at:
- http://yourhost:3000/
- https://yourhost:3001/
Options in all KasmVNC based GUI containers¶
This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.
Optional environment variables¶
| Variable | Description |
|---|---|
| CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default 3000. |
| CUSTOM_HTTPS_PORT | Internal port the container listens on for https if it needs to be swapped from the default 3001. |
| CUSTOM_USER | HTTP Basic auth username, abc is default. |
| PASSWORD | HTTP Basic auth password, abc is default. If unset there will be no auth |
| SUBFOLDER | Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/ |
| TITLE | The page title displayed on the web browser, default "KasmVNC Client". |
| FM_HOME | This is the home directory (landing) for the file manager, default "/config". |
| START_DOCKER | If set to false a container with privilege will not automatically start the DinD Docker setup. |
| DRINODE | If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE /dev/dri/renderD128 |
Optional run configurations¶
| Variable | Description |
|---|---|
--privileged | Will start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE -v /home/user/docker-data:/var/lib/docker. |
-v /var/run/docker.sock:/var/run/docker.sock | Mount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. |
--device /dev/dri:/dev/dri | Mount a GPU into the container, this can be used in conjunction with the DRINODE environment variable to leverage a host video card for GPU accelerated appplications. Only Open Source drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau) |
Lossless mode¶
This container is capable of delivering a true lossless image at a high framerate to your web browser by changing the Stream Quality preset to "Lossless", more information here. In order to use this mode from a non localhost endpoint the HTTPS port on 3001 needs to be used. If using a reverse proxy to port 3000 specific headers will need to be set as outlined here.
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)¶
---
+ github-desktop - LinuxServer.io linuxserver/github-desktop¶
Github Desktop is an open source Electron-based GitHub app. It is written in TypeScript and uses React.
Supported Architectures¶
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/github-desktop:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
The application can be accessed at:
- http://yourhost:3000/
- https://yourhost:3001/
Options in all KasmVNC based GUI containers¶
This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.
Optional environment variables¶
Variable Description CUSTOM_PORT Internal port the container listens on for http if it needs to be swapped from the default 3000. CUSTOM_HTTPS_PORT Internal port the container listens on for https if it needs to be swapped from the default 3001. CUSTOM_USER HTTP Basic auth username, abc is default. PASSWORD HTTP Basic auth password, abc is default. If unset there will be no auth SUBFOLDER Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/ TITLE The page title displayed on the web browser, default "KasmVNC Client". FM_HOME This is the home directory (landing) for the file manager, default "/config". START_DOCKER If set to false a container with privilege will not automatically start the DinD Docker setup. DRINODE If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE /dev/dri/renderD128
Optional run configurations¶
Variable Description --privilegedWill start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE -v /home/user/docker-data:/var/lib/docker. -v /var/run/docker.sock:/var/run/docker.sockMount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. --device /dev/dri:/dev/driMount a GPU into the container, this can be used in conjunction with the DRINODE environment variable to leverage a host video card for GPU accelerated appplications. Only Open Source drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau)
Lossless mode¶
This container is capable of delivering a true lossless image at a high framerate to your web browser by changing the Stream Quality preset to "Lossless", more information here. In order to use this mode from a non localhost endpoint the HTTPS port on 3001 needs to be used. If using a reverse proxy to port 3000 specific headers will need to be set as outlined here.
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)¶
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 3000Github Desktop gui. 3001HTTPS Github Desktop gui.
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configUsers home directory in the container, stores local files and settings
Miscellaneous Options¶
Parameter Function --shm-size=This is needed for electron applications to function properly. --security-opt seccomp=unconfinedFor Docker Engine only, many modern gui apps need this to function on older hosts as syscalls are unknown to Docker. Github Desktop runs in no-sandbox mode without it.
Portainer notice¶
{% hint style="warning" %} This image utilises cap_add or sysctl to work properly. This is not implemented properly in some versions of Portainer, thus this image may not work if deployed through Portainer.
Environment variables from files (Docker secrets)¶
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
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:
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 github-desktop /bin/bash- To monitor the logs of the container in realtime:
docker logs -f github-desktop- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' github-desktop- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/github-desktop:latest
Versions¶
- 03.08.23: - Rebase to Bookworm and multi arch.
- 01.04.23: - Initial release.
\ No newline at end of file
+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 github-desktop /bin/bash- To monitor the logs of the container in realtime:
docker logs -f github-desktop- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' github-desktop- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/github-desktop:latest
Versions¶
- 03.08.23: - Rebase to Bookworm and multi arch.
- 01.04.23: - Initial release.
linuxserver/gitqlient¶
GitQlient is a multi-platform Git client originally forked from QGit. Nowadays it goes beyond of just a fork and adds a lot of new functionality.
Supported Architectures¶
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/gitqlient:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
The application can be accessed at:
- http://yourhost:3000/
- https://yourhost:3001/
Options in all KasmVNC based GUI containers¶
This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.
Optional environment variables¶
| Variable | Description |
|---|---|
| CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default 3000. |
| CUSTOM_HTTPS_PORT | Internal port the container listens on for https if it needs to be swapped from the default 3001. |
| CUSTOM_USER | HTTP Basic auth username, abc is default. |
| PASSWORD | HTTP Basic auth password, abc is default. If unset there will be no auth |
| SUBFOLDER | Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/ |
| TITLE | The page title displayed on the web browser, default "KasmVNC Client". |
| FM_HOME | This is the home directory (landing) for the file manager, default "/config". |
| START_DOCKER | If set to false a container with privilege will not automatically start the DinD Docker setup. |
| DRINODE | If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE /dev/dri/renderD128 |
Optional run configurations¶
| Variable | Description |
|---|---|
--privileged | Will start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE -v /home/user/docker-data:/var/lib/docker. |
-v /var/run/docker.sock:/var/run/docker.sock | Mount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. |
--device /dev/dri:/dev/dri | Mount a GPU into the container, this can be used in conjunction with the DRINODE environment variable to leverage a host video card for GPU accelerated appplications. Only Open Source drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau) |
Lossless mode¶
This container is capable of delivering a true lossless image at a high framerate to your web browser by changing the Stream Quality preset to "Lossless", more information here. In order to use this mode from a non localhost endpoint the HTTPS port on 3001 needs to be used. If using a reverse proxy to port 3000 specific headers will need to be set as outlined here.
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)¶
---
+ gitqlient - LinuxServer.io linuxserver/gitqlient¶
GitQlient is a multi-platform Git client originally forked from QGit. Nowadays it goes beyond of just a fork and adds a lot of new functionality.
Supported Architectures¶
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/gitqlient:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
The application can be accessed at:
- http://yourhost:3000/
- https://yourhost:3001/
Options in all KasmVNC based GUI containers¶
This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.
Optional environment variables¶
Variable Description CUSTOM_PORT Internal port the container listens on for http if it needs to be swapped from the default 3000. CUSTOM_HTTPS_PORT Internal port the container listens on for https if it needs to be swapped from the default 3001. CUSTOM_USER HTTP Basic auth username, abc is default. PASSWORD HTTP Basic auth password, abc is default. If unset there will be no auth SUBFOLDER Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/ TITLE The page title displayed on the web browser, default "KasmVNC Client". FM_HOME This is the home directory (landing) for the file manager, default "/config". START_DOCKER If set to false a container with privilege will not automatically start the DinD Docker setup. DRINODE If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE /dev/dri/renderD128
Optional run configurations¶
Variable Description --privilegedWill start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE -v /home/user/docker-data:/var/lib/docker. -v /var/run/docker.sock:/var/run/docker.sockMount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. --device /dev/dri:/dev/driMount a GPU into the container, this can be used in conjunction with the DRINODE environment variable to leverage a host video card for GPU accelerated appplications. Only Open Source drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau)
Lossless mode¶
This container is capable of delivering a true lossless image at a high framerate to your web browser by changing the Stream Quality preset to "Lossless", more information here. In order to use this mode from a non localhost endpoint the HTTPS port on 3001 needs to be used. If using a reverse proxy to port 3000 specific headers will need to be set as outlined here.
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)¶
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 3000GitQlient desktop gui. 3001HTTPS GitQlient desktop gui.
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configUsers home directory in the container, stores local files and settings
Miscellaneous Options¶
Parameter Function --security-opt seccomp=unconfinedFor Docker Engine only, many modern gui apps need this to function on older hosts as syscalls are unknown to Docker
Environment variables from files (Docker secrets)¶
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
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:
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 gitqlient /bin/bash- To monitor the logs of the container in realtime:
docker logs -f gitqlient- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' gitqlient- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/gitqlient:latest
Versions¶
- 02.04.23: - Initial release.
\ No newline at end of file
+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 gitqlient /bin/bash- To monitor the logs of the container in realtime:
docker logs -f gitqlient- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' gitqlient- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/gitqlient:latest
Versions¶
- 02.04.23: - Initial release.
lsiodev/gmail-order-bot¶
Gmail-order-bot - A bot used to leverage a Gmail account as an order messaging service to consume email orders from Nano Checkout and process them using any custom logic you choose.
Supported Architectures¶
We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.
Simply pulling lscr.io/lsiodev/gmail-order-bot:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ✅ | arm32v7-<version tag> |
Application Setup¶
This container is for developers only! We make pre-defined bots we use in our workflow, but you have to have an underlying understanding of javascript and some basic Docker skills to use it.
The entire basis of this is to act as middleware between your email address receiving orders from https://checkout.linuxserver.io and send them to some external service. The bot will archive any messages that do not come from orders@nanocheckout.com with valid DKIM signatures, so definetly do not use this on a personal account.
The concept behind this bot and using email as a destination for orders is to serve normal users that simply want an email for an order out of the box and provide a free messaging queue akin to something like RabbitMQ for people that want to automate order ingestion.
By default we include bots we use that will be copied over on first container run, for example a simple discord ping when an order is received with the order details:
const Discord = require('discord.js');
+ gmail-order-bot - LinuxServer.io lsiodev/gmail-order-bot¶
Gmail-order-bot - A bot used to leverage a Gmail account as an order messaging service to consume email orders from Nano Checkout and process them using any custom logic you choose.
Supported Architectures¶
We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.
Simply pulling lscr.io/lsiodev/gmail-order-bot:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ✅ arm32v7-<version tag>
Application Setup¶
This container is for developers only! We make pre-defined bots we use in our workflow, but you have to have an underlying understanding of javascript and some basic Docker skills to use it.
The entire basis of this is to act as middleware between your email address receiving orders from https://checkout.linuxserver.io and send them to some external service. The bot will archive any messages that do not come from orders@nanocheckout.com with valid DKIM signatures, so definetly do not use this on a personal account.
The concept behind this bot and using email as a destination for orders is to serve normal users that simply want an email for an order out of the box and provide a free messaging queue akin to something like RabbitMQ for people that want to automate order ingestion.
By default we include bots we use that will be copied over on first container run, for example a simple discord ping when an order is received with the order details:
const Discord = require('discord.js');
const YAML = require('yaml');
const discordtoken = process.env.DISCORD_TOKEN;
const roomid = process.env.DISCORD_ROOM
@@ -42,4 +42,4 @@
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
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation BOT_NAME=discordOn successful order receive send the order payload to this bot (default bots are located in root/defaults/bots) LOOP_TIME=60Time in seconds to reach into gmail and get new messages to process
Volume Mappings (-v)¶
Volume Function /configPath to gmail tokens and custom/default bots
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:
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:
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 gmail-order-bot /bin/bash- To monitor the logs of the container in realtime:
docker logs -f gmail-order-bot- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' gmail-order-bot- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/lsiodev/gmail-order-bot:latest
Versions¶
- 06.07.20: - Initial Release.
\ No newline at end of file
+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 gmail-order-bot /bin/bash- To monitor the logs of the container in realtime:
docker logs -f gmail-order-bot- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' gmail-order-bot- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/lsiodev/gmail-order-bot:latest
Versions¶
- 06.07.20: - Initial Release.
linuxserver/grav¶
Grav is a Fast, Simple, and Flexible, file-based Web-platform.
Supported Architectures¶
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/grav:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
For more information check out the Grav documentation. Our image includes the grav-admin plugin.
To use the CLI tools you need to pass the working directory as part of your exec command (or use an interactive shell), e.g. docker exec -it -w /app/www/public grav bin/gpm
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)¶
---
+ grav - LinuxServer.io linuxserver/grav¶
Grav is a Fast, Simple, and Flexible, file-based Web-platform.
Supported Architectures¶
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/grav:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
For more information check out the Grav documentation. Our image includes the grav-admin plugin.
To use the CLI tools you need to pass the working directory as part of your exec command (or use an interactive shell), e.g. docker exec -it -w /app/www/public grav bin/gpm
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)¶
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 80Port for web frontend
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configContains all relevant configuration files.
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:
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:
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 grav /bin/bash- To monitor the logs of the container in realtime:
docker logs -f grav- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' grav- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/grav:latest
Versions¶
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 06.05.23: - Add php-ldap for LDAP support.
- 13.04.23: - Move ssl.conf include to default.conf.
- 11.12.22: - Rebase to Alpine 3.17, PHP 8.1.
- 05.09.22: - All php to read envs passed to container.
- 20.08.22: - Rebasing to alpine 3.15 with php8. Restructure nginx configs (see changes announcement).
- 03.09.21: - Added support for Redis caching.
- 01.07.21: - Rebase to Alpine 3.14.
- 09.04.21: - Initial Release.
\ No newline at end of file
+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 grav /bin/bash- To monitor the logs of the container in realtime:
docker logs -f grav- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' grav- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/grav:latest
Versions¶
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 06.05.23: - Add php-ldap for LDAP support.
- 13.04.23: - Move ssl.conf include to default.conf.
- 11.12.22: - Rebase to Alpine 3.17, PHP 8.1.
- 05.09.22: - All php to read envs passed to container.
- 20.08.22: - Rebasing to alpine 3.15 with php8. Restructure nginx configs (see changes announcement).
- 03.09.21: - Added support for Redis caching.
- 01.07.21: - Rebase to Alpine 3.14.
- 09.04.21: - Initial Release.
linuxserver/grocy¶
Grocy is an ERP system for your kitchen! Cut down on food waste, and manage your chores with this brilliant utility.
Keep track of your purchases, how much food you are wasting, what chores need doing and what batteries need charging with this proudly Open Source tool
For more information on grocy visit their website and check it out: https://grocy.info
Supported Architectures¶
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/grocy:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
Grocy is simple to get running. Configure the container with instructions below, start it, and you can then access it by visiting http://your.ip:9283 - once the page loads, you can log in with the default username and password of admin / admin
Upgrading¶
Following a container upgrade ensure that you visit the root (/) route (click on the logo in the left upper edge) in order to run any necessary database migrations. See https://github.com/grocy/grocy#how-to-update for more details.
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)¶
---
+ grocy - LinuxServer.io linuxserver/grocy¶
Grocy is an ERP system for your kitchen! Cut down on food waste, and manage your chores with this brilliant utility.
Keep track of your purchases, how much food you are wasting, what chores need doing and what batteries need charging with this proudly Open Source tool
For more information on grocy visit their website and check it out: https://grocy.info
Supported Architectures¶
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/grocy:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
Grocy is simple to get running. Configure the container with instructions below, start it, and you can then access it by visiting http://your.ip:9283 - once the page loads, you can log in with the default username and password of admin / admin
Upgrading¶
Following a container upgrade ensure that you visit the root (/) route (click on the logo in the left upper edge) in order to run any necessary database migrations. See https://github.com/grocy/grocy#how-to-update for more details.
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)¶
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 80will map the container's port 80 to port 9283 on the host
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configthis will store any uploaded data on the docker host
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:
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:
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 grocy /bin/bash- To monitor the logs of the container in realtime:
docker logs -f grocy- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' grocy- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/grocy:latest
Versions¶
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 13.04.23: - Move ssl.conf include to default.conf.
- 19.01.23: - Rebase to alpine 3.17 with php8.1.
- 20.08.22: - Rebasing to alpine 3.15 with php8. Restructure nginx configs (see changes announcement).
- 22.08.21: - Rebase to Alpine 3.14 and PHP 8.
- 25.07.21: - Add 'int','json' and 'zlib' PHP extensions.
- 10.05.21: - Reduce image size.
- 08.04.21: - Update docs to reflect jenkins builder changes.
- 17.02.21: - Rebasing to alpine 3.13.
- 26.01.21: - Add 'ldap' PHP extension.
- 22.12.20: - Add 'ctype' PHP extension.
- 01.06.20: - Rebasing to alpine 3.12.
- 19.12.19: - Rebasing to alpine 3.11.
- 22.09.19: - Add 'gd' PHP extension.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebasing to alpine 3.9.
- 27.12.18: - Initial Release.
\ No newline at end of file
+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 grocy /bin/bash- To monitor the logs of the container in realtime:
docker logs -f grocy- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' grocy- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/grocy:latest
Versions¶
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 13.04.23: - Move ssl.conf include to default.conf.
- 19.01.23: - Rebase to alpine 3.17 with php8.1.
- 20.08.22: - Rebasing to alpine 3.15 with php8. Restructure nginx configs (see changes announcement).
- 22.08.21: - Rebase to Alpine 3.14 and PHP 8.
- 25.07.21: - Add 'int','json' and 'zlib' PHP extensions.
- 10.05.21: - Reduce image size.
- 08.04.21: - Update docs to reflect jenkins builder changes.
- 17.02.21: - Rebasing to alpine 3.13.
- 26.01.21: - Add 'ldap' PHP extension.
- 22.12.20: - Add 'ctype' PHP extension.
- 01.06.20: - Rebasing to alpine 3.12.
- 19.12.19: - Rebasing to alpine 3.11.
- 22.09.19: - Add 'gd' PHP extension.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebasing to alpine 3.9.
- 27.12.18: - Initial Release.
DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. The last working tag is: 1.4.0-ls145 We recommend the official image instead: https://hub.docker.com/r/guacamole/guacd
linuxserver/guacd¶
Guacd - Apache Guacamole is a clientless remote desktop gateway. It supports standard protocols like VNC, RDP, and SSH. This container is only the backend server component needed to use The official or 3rd party HTML5 frontends.
Supported Architectures¶
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/guacd:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ✅ | arm32v7-<version tag> |
Application Setup¶
This is a backend only service, to leverage Guacd server you need to use either the official Java frontend guacamole-client or an open source alternative like guacamole-lite.
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)¶
---
+ guacd - LinuxServer.io DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. The last working tag is: 1.4.0-ls145 We recommend the official image instead: https://hub.docker.com/r/guacamole/guacd
linuxserver/guacd¶
Guacd - Apache Guacamole is a clientless remote desktop gateway. It supports standard protocols like VNC, RDP, and SSH. This container is only the backend server component needed to use The official or 3rd party HTML5 frontends.
Supported Architectures¶
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/guacd:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ✅ arm32v7-<version tag>
Application Setup¶
This is a backend only service, to leverage Guacd server you need to use either the official Java frontend guacamole-client or an open source alternative like guacamole-lite.
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:
guacd:
@@ -13,4 +13,4 @@
--restart unless-stopped \
lscr.io/linuxserver/guacd:latest
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 4822Port Guacamole server listens on
Environment Variables (-e)¶
Env Function
Volume Mappings (-v)¶
Volume Function
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:
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.
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 guacd /bin/bash- To monitor the logs of the container in realtime:
docker logs -f guacd- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' guacd- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/guacd:latest
Versions¶
- 15.02.23: - Deprecate image.
- 11.03.22: - Bump to 1.4.0.
- 15.05.21: - Add terminus font for SSH support.
- 08.05.21: - Bump to 1.3.0, rebase to Alpine.
- 27.07.20: - Bump to 1.2.0.
- 17.04.20: - Bump back 1.1.0, rebase to focal
- 08.02.20: - Bump to 1.1.0.
- 25.05.19: - Initial Release.
\ No newline at end of file
+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.
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 guacd /bin/bash- To monitor the logs of the container in realtime:
docker logs -f guacd- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' guacd- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/guacd:latest
Versions¶
- 15.02.23: - Deprecate image.
- 11.03.22: - Bump to 1.4.0.
- 15.05.21: - Add terminus font for SSH support.
- 08.05.21: - Bump to 1.3.0, rebase to Alpine.
- 27.07.20: - Bump to 1.2.0.
- 17.04.20: - Bump back 1.1.0, rebase to focal
- 08.02.20: - Bump to 1.1.0.
- 25.05.19: - Initial Release.
linuxserver/habridge¶
Habridge emulates Philips Hue API to other home automation gateways such as an Amazon Echo/Dot Gen 1 (gen 2 has issues discovering ha-bridge) or other systems that support Philips Hue. The Bridge handles basic commands such as "On", "Off" and "brightness" commands of the hue protocol. This bridge can control most devices that have a distinct API.
In the cases of systems that require authorization and/or have APIs that cannot be handled in the current method, a module may need to be built. The Harmony Hub is such a module and so is the Nest module. The Bridge has helpers to build devices for the gateway for the Logitech Harmony Hub, Vera, Vera Lite or Vera Edge, Nest, Somfy Tahoma, Home Assistant, Domoticz, MQTT, HAL, Fibaro, HomeWizard, LIFX, OpenHAB, FHEM, Broadlink and the ability to proxy all of your real Hue bridges behind this bridge.
This bridge was built to help put the Internet of Things together.
For more information about how to use this software have a look at their Wiki https://github.com/bwssytems/ha-bridge/wiki
Supported Architectures¶
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/habridge:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
To set up the ha-bridge simply go to http://localhost:8080. Once you are in the webui you can add devices and configure ha-bridge to your liking.
For information on how to configure ha-bridge, go to their wiki at https://github.com/bwssytems/ha-bridge/wiki
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)¶
---
+ habridge - LinuxServer.io linuxserver/habridge¶
Habridge emulates Philips Hue API to other home automation gateways such as an Amazon Echo/Dot Gen 1 (gen 2 has issues discovering ha-bridge) or other systems that support Philips Hue. The Bridge handles basic commands such as "On", "Off" and "brightness" commands of the hue protocol. This bridge can control most devices that have a distinct API.
In the cases of systems that require authorization and/or have APIs that cannot be handled in the current method, a module may need to be built. The Harmony Hub is such a module and so is the Nest module. The Bridge has helpers to build devices for the gateway for the Logitech Harmony Hub, Vera, Vera Lite or Vera Edge, Nest, Somfy Tahoma, Home Assistant, Domoticz, MQTT, HAL, Fibaro, HomeWizard, LIFX, OpenHAB, FHEM, Broadlink and the ability to proxy all of your real Hue bridges behind this bridge.
This bridge was built to help put the Internet of Things together.
For more information about how to use this software have a look at their Wiki https://github.com/bwssytems/ha-bridge/wiki
Supported Architectures¶
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/habridge:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
To set up the ha-bridge simply go to http://localhost:8080. Once you are in the webui you can add devices and configure ha-bridge to your liking.
For information on how to configure ha-bridge, go to their wiki at https://github.com/bwssytems/ha-bridge/wiki
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)¶
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 8080WebUI 50000HABridge communication port.
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. SEC_KEY=<Your Key To Encrypt Security Data>Key used to secure communication.
Volume Mappings (-v)¶
Volume Function /configWhere HABridge stores config files and data.
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:
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:
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 habridge /bin/bash- To monitor the logs of the container in realtime:
docker logs -f habridge- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' habridge- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/habridge:latest
Versions¶
- 25.08.23: - Rebase to Alpine 3.18.
- 07.07.23: - Deprecate armhf. As announced here
- 11.12.22: - Rebasing to alpine 3.17.
- 23.01.21: - Rebasing to alpine 3.13.
- 01.06.20: - Rebasing to alpine 3.12.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebasing to alpine 3.9.
- 11.02.19: - Add pipeline logic and multi arch.
- 28.08.18: - Rebase to alpine 3.8.
- 12.04.18: - Add workaround to bind to port 80 if needed.
- 08.04.18: - Initial Release.
\ No newline at end of file
+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 habridge /bin/bash- To monitor the logs of the container in realtime:
docker logs -f habridge- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' habridge- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/habridge:latest
Versions¶
- 25.08.23: - Rebase to Alpine 3.18.
- 07.07.23: - Deprecate armhf. As announced here
- 11.12.22: - Rebasing to alpine 3.17.
- 23.01.21: - Rebasing to alpine 3.13.
- 01.06.20: - Rebasing to alpine 3.12.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebasing to alpine 3.9.
- 11.02.19: - Add pipeline logic and multi arch.
- 28.08.18: - Rebase to alpine 3.8.
- 12.04.18: - Add workaround to bind to port 80 if needed.
- 08.04.18: - Initial Release.
linuxserver/headphones¶
Headphones is an automated music downloader for NZB and Torrent, written in Python. It supports SABnzbd, NZBget, Transmission, µTorrent and Blackhole.
Supported Architectures¶
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/headphones:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
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)¶
---
+ headphones - LinuxServer.io linuxserver/headphones¶
Headphones is an automated music downloader for NZB and Torrent, written in Python. It supports SABnzbd, NZBget, Transmission, µTorrent and Blackhole.
Supported Architectures¶
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/headphones:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
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)¶
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 8181Application WebUI
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configConfiguration files. /downloadsISOs. /musicYour music directory.
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:
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:
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 headphones /bin/bash- To monitor the logs of the container in realtime:
docker logs -f headphones- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' headphones- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/headphones:latest
Versions¶
- 06.07.23: - Deprecate armhf. As announced here
- 23.02.23: - Rebase to Alpine 3.17, migrate to s6v3.
- 02.02.22: - Rebasing to alpine 3.15. Updating to Python 3.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 09.05.19: - Add default UTC timezone if user does not set it.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebasing to alpine 3.9.
- 16.01.19: - Add pipeline logic and multi arch.
- 18.08.18: - Rebase to alpine 3.8.
- 03.04.18: - Remove forced port and update README.
- 05.01.18: - Deprecate cpu_core routine lack of scaling.
- 12.12.17: - Rebase to alpine 3.7.
- 20.07.17: - Internal git pull instead of at runtime.
- 12.07.17: - Add inspect commands to README, move to jenkins build and push.
- 28.05.17: - Add flac package to handle FLAC based .cue.
- 25.05.17: - Rebase to alpine 3.6.
- 03.05.17: - Reduce layer, replace broken source for shntool.
- 07.02.17: - Rebase to alpine 3.5.
- 23.12.16: - Fix capitalisation in README.
- 09.09.16: - Add layer badges to README.
- 27.08.16: - Add badges to README, compile shntool.
- 08.08.16: - Rebase to alpine linux.
- 18.07.15: - Inital Release
\ No newline at end of file
+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 headphones /bin/bash- To monitor the logs of the container in realtime:
docker logs -f headphones- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' headphones- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/headphones:latest
Versions¶
- 06.07.23: - Deprecate armhf. As announced here
- 23.02.23: - Rebase to Alpine 3.17, migrate to s6v3.
- 02.02.22: - Rebasing to alpine 3.15. Updating to Python 3.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 09.05.19: - Add default UTC timezone if user does not set it.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebasing to alpine 3.9.
- 16.01.19: - Add pipeline logic and multi arch.
- 18.08.18: - Rebase to alpine 3.8.
- 03.04.18: - Remove forced port and update README.
- 05.01.18: - Deprecate cpu_core routine lack of scaling.
- 12.12.17: - Rebase to alpine 3.7.
- 20.07.17: - Internal git pull instead of at runtime.
- 12.07.17: - Add inspect commands to README, move to jenkins build and push.
- 28.05.17: - Add flac package to handle FLAC based .cue.
- 25.05.17: - Rebase to alpine 3.6.
- 03.05.17: - Reduce layer, replace broken source for shntool.
- 07.02.17: - Rebase to alpine 3.5.
- 23.12.16: - Fix capitalisation in README.
- 09.09.16: - Add layer badges to README.
- 27.08.16: - Add badges to README, compile shntool.
- 08.08.16: - Rebase to alpine linux.
- 18.07.15: - Inital Release
linuxserver/healthchecks¶
Healthchecks is a watchdog for your cron jobs. It's a web server that listens for pings from your cron jobs, plus a web interface.
Supported Architectures¶
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/healthchecks:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
Access the WebUI at
Note on CSRF_TRUSTED_ORIGINS¶
On first run (or any startup where REGENERATE_SETTINGS=true) we will set CSRF_TRUSTED_ORIGINS to match the value of SITE_ROOT. If you need different/additional origins, you will need to edit /config/local_settings.py and add them yourself. Note that setting REGENERATE_SETTINGS=true will overwrite any changes on startup.
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)¶
---
+ healthchecks - LinuxServer.io linuxserver/healthchecks¶
Healthchecks is a watchdog for your cron jobs. It's a web server that listens for pings from your cron jobs, plus a web interface.
Supported Architectures¶
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/healthchecks:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
Access the WebUI at :8000. For more information, check out Healthchecks.
Note on CSRF_TRUSTED_ORIGINS¶
On first run (or any startup where REGENERATE_SETTINGS=true) we will set CSRF_TRUSTED_ORIGINS to match the value of SITE_ROOT. If you need different/additional origins, you will need to edit /config/local_settings.py and add them yourself. Note that setting REGENERATE_SETTINGS=true will overwrite any changes on startup.
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)¶
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 8000Healthchecks Web UI 2525Port for inbound SMTP pings
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. SITE_ROOT=The site's top-level URL and the port it listens to if differrent than 80 or 443 (e.g., https://healthchecks.example.com:8000) SITE_NAME=The site's name (e.g., "Example Corp HealthChecks") DEFAULT_FROM_EMAIL=From email for alerts EMAIL_HOST=SMTP host EMAIL_PORT=SMTP port EMAIL_HOST_USER=SMTP user EMAIL_HOST_PASSWORD=SMTP password EMAIL_USE_TLS=Use TLS for SMTP (True or False) SUPERUSER_EMAIL=Superuser email SUPERUSER_PASSWORD=Superuser password REGENERATE_SETTINGS=Defaults to False. Set to True to always override the local_settings.py file with values from environment variables. Do not set to True if you have made manual modifications to this file. ALLOWED_HOSTS=Array of valid hostnames for the server ["test.com","test2.com"] (default: ["*"]) APPRISE_ENABLED=Defaults to False. A boolean that turns on/off the Apprise integration (https://github.com/caronc/apprise) DEBUG=Defaults to True. Debug mode relaxes CSRF protections and increases logging verbosity but should be disabled for production instances as it will impact performance and security. INTEGRATIONS_ALLOW_PRIVATE_IPS=Defaults to False. Set to True to allow integrations to connect to private IP addresses. PING_EMAIL_DOMAIN=The domain to use for generating ping email addresses. SECRET_KEY=A secret key used for cryptographic signing. Will generate a secure value if one is not supplied SITE_LOGO_URL=Full URL to custom site logo
Volume Mappings (-v)¶
Volume Function /configDatabase and healthchecks config directory
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:
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:
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 healthchecks /bin/bash- To monitor the logs of the container in realtime:
docker logs -f healthchecks- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' healthchecks- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/healthchecks:latest
Versions¶
- 31.05.23: - Rebase to Alpine 3.18. Deprecate armhf.
- 22.12.22: - Rebase to Alpine 3.17. Add extra deps for pycurl. Add INTEGRATIONS_ALLOW_PRIVATE_IPS.
- 18.10.22: - Add curl-dev to fix broken pip builds.
- 11.10.22: - Rebase to Alpine 3.16, migrate to s6v3.
- 27.09.22: - Fix sending of Email Reports
- 08.01.22: - Fix CSRF setting for Django 4.0 (introduced in v1.25.0)
- 11.11.21: - Add Apprise to Docker as in v1.24.0
- 10.09.21: - Fix creation of superuser
- 07.08.21: - Update custom logo handling to support changes in v1.22.0
- 11.07.21: - Rebase to Alpine 3.14.
- 18.05.21: - Add linuxserver wheel index.
- 11.01.21: - Add libffi-dev to allow building of python cryptography lib.
- 19.07.20: - Rebasing to alpine 3.12, fixed 'ALLOWED_HOSTS' bug, now defaults to wildcard
- 19.12.19: - Rebasing to alpine 3.11.
- 31.10.19: - Add postgres client and fix config for CSRF.
- 23.10.19: - Allow to create superuser
- 28.06.19: - Rebasing to alpine 3.10.
- 12.04.19: - Rebase to Alpine 3.9.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 14.02.19: - Adding mysql libs needed for using a database.
- 11.10.18: - adding pipeline logic and multi arching release
- 15.11.17: -
git pull is now in Dockerfile so each tagged container contains the same code version - 17.10.17: - Fixed
local_settings.py output - 27.09.17: - Initial Release.
\ No newline at end of file
+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 healthchecks /bin/bash- To monitor the logs of the container in realtime:
docker logs -f healthchecks- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' healthchecks- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/healthchecks:latest
Versions¶
- 31.05.23: - Rebase to Alpine 3.18. Deprecate armhf.
- 22.12.22: - Rebase to Alpine 3.17. Add extra deps for pycurl. Add INTEGRATIONS_ALLOW_PRIVATE_IPS.
- 18.10.22: - Add curl-dev to fix broken pip builds.
- 11.10.22: - Rebase to Alpine 3.16, migrate to s6v3.
- 27.09.22: - Fix sending of Email Reports
- 08.01.22: - Fix CSRF setting for Django 4.0 (introduced in v1.25.0)
- 11.11.21: - Add Apprise to Docker as in v1.24.0
- 10.09.21: - Fix creation of superuser
- 07.08.21: - Update custom logo handling to support changes in v1.22.0
- 11.07.21: - Rebase to Alpine 3.14.
- 18.05.21: - Add linuxserver wheel index.
- 11.01.21: - Add libffi-dev to allow building of python cryptography lib.
- 19.07.20: - Rebasing to alpine 3.12, fixed 'ALLOWED_HOSTS' bug, now defaults to wildcard
- 19.12.19: - Rebasing to alpine 3.11.
- 31.10.19: - Add postgres client and fix config for CSRF.
- 23.10.19: - Allow to create superuser
- 28.06.19: - Rebasing to alpine 3.10.
- 12.04.19: - Rebase to Alpine 3.9.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 14.02.19: - Adding mysql libs needed for using a database.
- 11.10.18: - adding pipeline logic and multi arching release
- 15.11.17: -
git pullis now in Dockerfile so each tagged container contains the same code version - 17.10.17: - Fixed
local_settings.pyoutput - 27.09.17: - Initial Release.
linuxserver/hedgedoc¶
HedgeDoc gives you access to all your files wherever you are.
HedgeDoc is a real-time, multi-platform collaborative markdown note editor. This means that you can write notes with other people on your desktop, tablet or even on the phone. You can sign-in via multiple auth providers like Facebook, Twitter, GitHub and many more on the homepage.
Supported Architectures¶
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/hedgedoc:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
HedgeDoc web interface can be accessed http://${IP}:3000/, if you want to use a custom domain or anything besides port 3000 you will need to leverage their env settings for callbacks: (specifically for CMD_DOMAIN, CMD_PORT and CMD_URL_ADDPORT)
For convience we provide a working example using Mysql as a backend in this document, if you do not wish to use our custom environment values or a Mysql database backend feel free to leverage any of the settings laid out in the link above.
To run behind a reverse proxy we have a preconfigured config using docker networking included in our SWAG image and you can read how to use this in the Reverse Proxy Confs repository
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)¶
---
+ hedgedoc - LinuxServer.io linuxserver/hedgedoc¶
HedgeDoc gives you access to all your files wherever you are.
HedgeDoc is a real-time, multi-platform collaborative markdown note editor. This means that you can write notes with other people on your desktop, tablet or even on the phone. You can sign-in via multiple auth providers like Facebook, Twitter, GitHub and many more on the homepage.
Supported Architectures¶
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/hedgedoc:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
HedgeDoc web interface can be accessed http://${IP}:3000/, if you want to use a custom domain or anything besides port 3000 you will need to leverage their env settings for callbacks: (specifically for CMD_DOMAIN, CMD_PORT and CMD_URL_ADDPORT)
For convience we provide a working example using Mysql as a backend in this document, if you do not wish to use our custom environment values or a Mysql database backend feel free to leverage any of the settings laid out in the link above.
To run behind a reverse proxy we have a preconfigured config using docker networking included in our SWAG image and you can read how to use this in the Reverse Proxy Confs repository
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)¶
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 3000Web gui port (internal port also needs to be changed if accessing at port other than 80, 443 and 3000).
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. DB_HOST=<hostname or ip>Host address of mysql database DB_PORT=3306Port to access mysql database default is 3306 DB_USER=hedgedocDatabase user DB_PASS=<secret password>Database password DB_NAME=hedgedocDatabase name CMD_DOMAIN=localhostThe address the gui will be accessed at (ie. 192.168.1.1 or hedgedoc.domain.com). CMD_URL_ADDPORT=falseSet to true if using a port other than 80 or 443. CMD_PROTOCOL_USESSL=falseSet to true if accessing over https via reverse proxy. CMD_PORT=3000If you wish to access hedgedoc at a port different than 80, 443 or 3000, you need to set this to that port (ie. CMD_PORT=5000) and change the port mapping accordingly (5000:5000). CMD_ALLOW_ORIGIN=['localhost']Comma-separated list of allowed hostnames
Volume Mappings (-v)¶
Volume Function /configHedgeDoc config and configurable files
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:
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:
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 hedgedoc /bin/bash- To monitor the logs of the container in realtime:
docker logs -f hedgedoc- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' hedgedoc- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/hedgedoc:latest
Versions¶
- 18.06.23: - Rebase to Alpine 3.18, deprecate armhf as per https://www.linuxserver.io/armhf.
- 02.11.22: - Rebase to Alpine 3.16, migrate to s6v3.
- 10.04.22: - Use python3 to build node sqlite3.
- 10.02.22: - Rebase to Alpine 3.15.
- 09.02.22: - Add optional var
CMD_PORT that is needed for accessing at port other than 80, 443 and 3000. - 09.12.21: - Add optional var
CMD_PROTOCOL_USESSL that is needed for reverse proxy. - 07.12.21: - Rebase to ubuntu focal. Update to node 16. Make sure uploads are persistent.
- 15.10.21: - Add required env var
CMD_DOMAIN. - 05.05.21: - Remove symlinking some folders from config to /opt/hedgedoc/public.
- 03.05.21: - Remove deprecated sequalizerc step.
- 22.12.20: - Initial release
\ No newline at end of file
+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 hedgedoc /bin/bash- To monitor the logs of the container in realtime:
docker logs -f hedgedoc- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' hedgedoc- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/hedgedoc:latest
Versions¶
- 18.06.23: - Rebase to Alpine 3.18, deprecate armhf as per https://www.linuxserver.io/armhf.
- 02.11.22: - Rebase to Alpine 3.16, migrate to s6v3.
- 10.04.22: - Use python3 to build node sqlite3.
- 10.02.22: - Rebase to Alpine 3.15.
- 09.02.22: - Add optional var
CMD_PORTthat is needed for accessing at port other than 80, 443 and 3000. - 09.12.21: - Add optional var
CMD_PROTOCOL_USESSLthat is needed for reverse proxy. - 07.12.21: - Rebase to ubuntu focal. Update to node 16. Make sure uploads are persistent.
- 15.10.21: - Add required env var
CMD_DOMAIN. - 05.05.21: - Remove symlinking some folders from config to /opt/hedgedoc/public.
- 03.05.21: - Remove deprecated sequalizerc step.
- 22.12.20: - Initial release
linuxserver/heimdall¶
Heimdall is a way to organise all those links to your most used web sites and web applications in a simple way.
Simplicity is the key to Heimdall.
Why not use it as your browser start page? It even has the ability to include a search bar using either Google, Bing or DuckDuckGo.
Supported Architectures¶
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/heimdall:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
| Tag | Available | Description |
|---|---|---|
| latest | ✅ | Stable Heimdall releases. |
| development | ✅ | Latest commit from the github 2.x branch. |
| ## Application Setup |
Access the web gui at http://SERVERIP:PORT
Adding password protection¶
This image now supports password protection through htpasswd. Run the following command on your host to generate the htpasswd file docker exec -it heimdall htpasswd -c /config/nginx/.htpasswd <username>. Replace basic auth lines in /config/nginx/site-confs/default.conf and restart the container.
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)¶
---
+ heimdall - LinuxServer.io linuxserver/heimdall¶
Heimdall is a way to organise all those links to your most used web sites and web applications in a simple way.
Simplicity is the key to Heimdall.
Why not use it as your browser start page? It even has the ability to include a search bar using either Google, Bing or DuckDuckGo.
Supported Architectures¶
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/heimdall:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
Tag Available Description latest ✅ Stable Heimdall releases. development ✅ Latest commit from the github 2.x branch. ## Application Setup
Access the web gui at http://SERVERIP:PORT
Adding password protection¶
This image now supports password protection through htpasswd. Run the following command on your host to generate the htpasswd file docker exec -it heimdall htpasswd -c /config/nginx/.htpasswd <username>. Replace with a username of your choice and you will be asked to enter a password. Uncomment the basic auth lines in /config/nginx/site-confs/default.conf and restart the container.
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)¶
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 80http gui 443https gui
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configContains all relevant configuration files.
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:
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:
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 heimdall /bin/bash- To monitor the logs of the container in realtime:
docker logs -f heimdall- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' heimdall- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/heimdall:latest
Versions¶
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 13.04.23: - Move ssl.conf include to default.conf.
- 20.01.23: - Rebase to alpine 3.17 with php8.1.
- 14.11.22: - Rebasing to alpine 3.15 with php8. Restructure nginx configs (see changes announcement).
- 04.11.22: - Build commits to upstream branch 2.x for the
development tag. - 13.03.21: - Make searchproviders.yaml user configurable.
- 10.02.21: - Revert to alpine 3.12 as php 7.4 broke laravel.
- 10.02.21: - Rebasing to alpine 3.13.
- 17.08.20: - Add php7-curl.
- 01.06.20: - Rebasing to alpine 3.12.
- 17.01.20: - Use nginx from baseimage.
- 19.12.19: - Rebasing to alpine 3.11.
- 16.07.19: - Save laravel.log to /config/log/heimdall.
- 28.06.19: - Rebasing to alpine 3.10.
- 01.04.19: - Fix permission detect logic.
- 26.03.19: - Install Heimdall during container start to prevent delayed start due to overlayfs bug with recursive chown.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 15.03.19: - Clarify docker image tags in readme.
- 22.02.19: - Rebasing to alpine 3.9.
- 16.01.18: - Generate random app key in .env for new installs.
- 20.11.18: - Upgrade baseimage packages during build.
- 04.11.18: - Add php7-zip.
- 31.10.18: - Add queue service.
- 17.10.18: - Symlink avatars folder.
- 16.10.18: - Updated fastcgi_params for user login support.
- 07.10.18: - Symlink
.env rather than copy. It now resides under /config/www - 30.09.18: - Multi-arch image. Move
.env to /config. - 05.09.18: - Rebase to alpine linux 3.8.
- 06.03.18: - Use password protection if htpasswd is set. Existing users can delete their default site config at /config/nginx/site-confs/default.conf and restart the container, a new default site config with htpasswd support will be created in its place
- 12.02.18: - Initial Release.
\ No newline at end of file
+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 heimdall /bin/bash- To monitor the logs of the container in realtime:
docker logs -f heimdall- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' heimdall- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/heimdall:latest
Versions¶
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 13.04.23: - Move ssl.conf include to default.conf.
- 20.01.23: - Rebase to alpine 3.17 with php8.1.
- 14.11.22: - Rebasing to alpine 3.15 with php8. Restructure nginx configs (see changes announcement).
- 04.11.22: - Build commits to upstream branch 2.x for the
developmenttag. - 13.03.21: - Make searchproviders.yaml user configurable.
- 10.02.21: - Revert to alpine 3.12 as php 7.4 broke laravel.
- 10.02.21: - Rebasing to alpine 3.13.
- 17.08.20: - Add php7-curl.
- 01.06.20: - Rebasing to alpine 3.12.
- 17.01.20: - Use nginx from baseimage.
- 19.12.19: - Rebasing to alpine 3.11.
- 16.07.19: - Save laravel.log to /config/log/heimdall.
- 28.06.19: - Rebasing to alpine 3.10.
- 01.04.19: - Fix permission detect logic.
- 26.03.19: - Install Heimdall during container start to prevent delayed start due to overlayfs bug with recursive chown.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 15.03.19: - Clarify docker image tags in readme.
- 22.02.19: - Rebasing to alpine 3.9.
- 16.01.18: - Generate random app key in .env for new installs.
- 20.11.18: - Upgrade baseimage packages during build.
- 04.11.18: - Add php7-zip.
- 31.10.18: - Add queue service.
- 17.10.18: - Symlink avatars folder.
- 16.10.18: - Updated fastcgi_params for user login support.
- 07.10.18: - Symlink
.envrather than copy. It now resides under/config/www - 30.09.18: - Multi-arch image. Move
.envto/config. - 05.09.18: - Rebase to alpine linux 3.8.
- 06.03.18: - Use password protection if htpasswd is set. Existing users can delete their default site config at /config/nginx/site-confs/default.conf and restart the container, a new default site config with htpasswd support will be created in its place
- 12.02.18: - Initial Release.
linuxserver/hishtory-server¶
hiSHtory is a better shell history. It stores your shell history in context (what directory you ran the command in, whether it succeeded or failed, how long it took, etc). This is all stored locally and end-to-end encrypted for syncing to to all your other computers.
Supported Architectures¶
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/hishtory-server:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
This container requires an external postgres database.
After you have installed hishtory on your machine, add export HISHTORY_SERVER=http://1.2.3.4:8080 (with your server details) to your shellrc. Then run hishtory init (or hishtory init ${SECRET_KEY}) to initialise hishtory against your local server.
See the project readme for more details.
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)¶
---
+ hishtory-server - LinuxServer.io linuxserver/hishtory-server¶
hiSHtory is a better shell history. It stores your shell history in context (what directory you ran the command in, whether it succeeded or failed, how long it took, etc). This is all stored locally and end-to-end encrypted for syncing to to all your other computers.
Supported Architectures¶
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/hishtory-server:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
This container requires an external postgres database.
After you have installed hishtory on your machine, add export HISHTORY_SERVER=http://1.2.3.4:8080 (with your server details) to your shellrc. Then run hishtory init (or hishtory init ${SECRET_KEY}) to initialise hishtory against your local server.
See the project readme for more details.
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)¶
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 8080API port
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. HISHTORY_POSTGRES_DB=postgresql://${HISHTORY_DB_USER}:${HISHTORY_DB_PASS}@hishtory-db:5432/hishtory?sslmode=disablePostgres DB Connection URI. Special characters must be URL encoded.
Volume Mappings (-v)¶
Volume Function
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:
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:
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 hishtory-server /bin/bash- To monitor the logs of the container in realtime:
docker logs -f hishtory-server- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' hishtory-server- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/hishtory-server:latest
Versions¶
- 19.05.23: - Initial Release.
\ No newline at end of file
+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 hishtory-server /bin/bash- To monitor the logs of the container in realtime:
docker logs -f hishtory-server- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' hishtory-server- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/hishtory-server:latest
Versions¶
- 19.05.23: - Initial Release.
linuxserver/homeassistant¶
Home Assistant Core - Open source home automation that puts local control and privacy first. Powered by a worldwide community of tinkerers and DIY enthusiasts. Perfect to run on a Raspberry Pi or a local server.
Supported Architectures¶
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/homeassistant:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
This image is based on Home Assistant Core.
The Webui can be found at http://your-ip:8123. Follow the wizard to set up Home Assistant.
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)¶
---
+ homeassistant - LinuxServer.io linuxserver/homeassistant¶
Home Assistant Core - Open source home automation that puts local control and privacy first. Powered by a worldwide community of tinkerers and DIY enthusiasts. Perfect to run on a Raspberry Pi or a local server.
Supported Architectures¶
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/homeassistant:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
This image is based on Home Assistant Core.
The Webui can be found at http://your-ip:8123. Follow the wizard to set up Home Assistant.
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)¶
Host vs. Bridge¶
Home Assistant can discover and automatically configure zeroconf/mDNS and UPnP devices on your network. In order for this to work you must create the container with --net=host.
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 8123Application WebUI, only use this if you are not using host mode.
Networking (--net)¶
Parameter Function --net=hostShares host networking with container. Required for some devices to be discovered by Home Assistant.
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configHome Assistant config storage path.
Device Mappings (--device)¶
Parameter Function /path/to/deviceFor passing through USB, serial or gpio devices.
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:
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:
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 homeassistant /bin/bash- To monitor the logs of the container in realtime:
docker logs -f homeassistant- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' homeassistant- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/homeassistant:latest
Versions¶
- 05.07.23: - Deprecate armhf. As announced here
- 21.06.23: - Pin pycups version.
- 14.06.23: - Create secondary venv in
/config for pip installs. - 07.06.23: - Rebase to alpine 3.18, switch to cp311 wheels.
- 03.05.23: - Deprecate arm32v7. Latest HA version with an arm32v7 build is
2023.4.6. - 16.11.22: - Fix the dep conflict for google calendar.
- 23.09.22: - Migrate to s6v3.
- 29.07.22: - Improve usb device permission fix.
- 07.07.22: - Rebase to alpine 3.16, switch to cp310 wheels.
- 07.05.22: - Build matplotlib with the same Numpy version as HA req.
- 31.03.22: - Install pycups.
- 07.03.22: - Install PySwitchbot.
- 02.03.22: - Update pip and use legacy resolver, clean up temp python files, reduce image size.
- 04.02.22: - Always compile grpcio on arm32v7 due to pypi pushing a glibc only wheel.
- 12.12.21: - Use the new
build.yaml to determine HA base version. - 25.09.21: - Use the new lsio homeassistant wheel repo, instead of the HA wheels.
- 13.09.21: - Build psycopg locally as the HA provided wheel does not seem to work properly.
- 13.09.21: - Fix setcap in service. Build CISO8601 locally as the HA provided wheel does not seem to work properly.
- 12.09.21: - Rebase to alpine 3.14. Build on native armhf.
- 09.08.21: - Fixed broken build caused by missing dependency.
- 01.07.21: - Remove HACS dependencies as it caused a crash in Home-assistant.
- 25.02.21: - Add python dependencies from homeassistant base image.
- 07.02.21: - Fix building from the wrong requirement file. Add ssh client & external DB libs.
- 06.02.21: - Add iputils so ping works as non root user.
- 30.01.21: - Initial Release.
\ No newline at end of file
+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 homeassistant /bin/bash- To monitor the logs of the container in realtime:
docker logs -f homeassistant- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' homeassistant- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/homeassistant:latest
Versions¶
- 05.07.23: - Deprecate armhf. As announced here
- 21.06.23: - Pin pycups version.
- 14.06.23: - Create secondary venv in
/configfor pip installs. - 07.06.23: - Rebase to alpine 3.18, switch to cp311 wheels.
- 03.05.23: - Deprecate arm32v7. Latest HA version with an arm32v7 build is
2023.4.6. - 16.11.22: - Fix the dep conflict for google calendar.
- 23.09.22: - Migrate to s6v3.
- 29.07.22: - Improve usb device permission fix.
- 07.07.22: - Rebase to alpine 3.16, switch to cp310 wheels.
- 07.05.22: - Build matplotlib with the same Numpy version as HA req.
- 31.03.22: - Install pycups.
- 07.03.22: - Install PySwitchbot.
- 02.03.22: - Update pip and use legacy resolver, clean up temp python files, reduce image size.
- 04.02.22: - Always compile grpcio on arm32v7 due to pypi pushing a glibc only wheel.
- 12.12.21: - Use the new
build.yamlto determine HA base version. - 25.09.21: - Use the new lsio homeassistant wheel repo, instead of the HA wheels.
- 13.09.21: - Build psycopg locally as the HA provided wheel does not seem to work properly.
- 13.09.21: - Fix setcap in service. Build CISO8601 locally as the HA provided wheel does not seem to work properly.
- 12.09.21: - Rebase to alpine 3.14. Build on native armhf.
- 09.08.21: - Fixed broken build caused by missing dependency.
- 01.07.21: - Remove HACS dependencies as it caused a crash in Home-assistant.
- 25.02.21: - Add python dependencies from homeassistant base image.
- 07.02.21: - Fix building from the wrong requirement file. Add ssh client & external DB libs.
- 06.02.21: - Add iputils so ping works as non root user.
- 30.01.21: - Initial Release.
linuxserver/htpcmanager¶
Htpcmanager is a front end for many htpc related applications.
Supported Architectures¶
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/htpcmanager:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
The webui is found at port 8085. Smartmontools and psutil have not been included, you can safely ignore the warning error in the log.
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)¶
---
+ htpcmanager - LinuxServer.io linuxserver/htpcmanager¶
Htpcmanager is a front end for many htpc related applications.
Supported Architectures¶
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/htpcmanager:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
The webui is found at port 8085. Smartmontools and psutil have not been included, you can safely ignore the warning error in the log.
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)¶
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 8085Application WebUI
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configConfiguration files.
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:
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:
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 htpcmanager /bin/bash- To monitor the logs of the container in realtime:
docker logs -f htpcmanager- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' htpcmanager- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/htpcmanager:latest
Versions¶
- 25.08.23: - Rebase to Alpine 3.18.
- 04.07.23: - Deprecate armhf. As announced here
- 13.02.23: - Rebase to Alpine 3.17, migrate to s6v3.
- 24.08.22: - Rebase to alpine 3.15, use linuxserver.io wheel repo.
- 08.04.21: - Fix build.
- 10.02.21: - Rebasing to alpine 3.13.
- 26.10.20: - Rebase to alpine 3.12, python3, change upstream project
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebasing to alpine 3.9.
- 16.01.19: - Add pipeline logic and multi arch.
- 17.08.18: - Rebase to alpine 3.8.
- 12.12.17: - Rebase to alpine 3.7.
- 20.07.17: - Internal git pull instead of at runtime.
- 25.05.17: - Rebase to alpine 3.6.
- 07.02.17: - Rebase to alpine 3.5.
- 14.10.16: - Add version layer information.
- 26.09.16: - Add back cherrypy after removal from baseimage.
- 10.09.16: - Add layer badges to README.
- 28.08.16: - Add badges to README.
- 08.08.16: - Rebase to alpine linux.
- 14.01.15: - Remove hardcoded loglevel from the run command, set in webui
- 19.09.15: - Initial Release.
\ No newline at end of file
+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 htpcmanager /bin/bash- To monitor the logs of the container in realtime:
docker logs -f htpcmanager- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' htpcmanager- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/htpcmanager:latest
Versions¶
- 25.08.23: - Rebase to Alpine 3.18.
- 04.07.23: - Deprecate armhf. As announced here
- 13.02.23: - Rebase to Alpine 3.17, migrate to s6v3.
- 24.08.22: - Rebase to alpine 3.15, use linuxserver.io wheel repo.
- 08.04.21: - Fix build.
- 10.02.21: - Rebasing to alpine 3.13.
- 26.10.20: - Rebase to alpine 3.12, python3, change upstream project
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebasing to alpine 3.9.
- 16.01.19: - Add pipeline logic and multi arch.
- 17.08.18: - Rebase to alpine 3.8.
- 12.12.17: - Rebase to alpine 3.7.
- 20.07.17: - Internal git pull instead of at runtime.
- 25.05.17: - Rebase to alpine 3.6.
- 07.02.17: - Rebase to alpine 3.5.
- 14.10.16: - Add version layer information.
- 26.09.16: - Add back cherrypy after removal from baseimage.
- 10.09.16: - Add layer badges to README.
- 28.08.16: - Add badges to README.
- 08.08.16: - Rebase to alpine linux.
- 14.01.15: - Remove hardcoded loglevel from the run command, set in webui
- 19.09.15: - Initial Release.
DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated.
linuxserver/hydra¶
Hydra is a meta search for NZB indexers and the "spiritual successor" to NZBmegasearcH. It provides easy access to a number of raw and newznab based indexers.
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/hydra 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 | amd64-latest |
| arm64 | arm64v8-latest |
| armhf | arm32v7-latest |
Usage¶
Here are some example snippets to help you get started creating a container from this image.
docker-compose (recommended)¶
Compatible with docker-compose v2 schemas.
---
+ hydra - LinuxServer.io DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated.
linuxserver/hydra¶
Hydra is a meta search for NZB indexers and the "spiritual successor" to NZBmegasearcH. It provides easy access to a number of raw and newznab based indexers.
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/hydra 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 amd64-latest arm64 arm64v8-latest armhf arm32v7-latest
Usage¶
Here are some example snippets to help you get started creating a container from this image.
docker-compose (recommended)¶
Compatible with docker-compose v2 schemas.
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 5075WebUI
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Europe/LondonSpecify a timezone to use EG Europe/London.
Volume Mappings (-v)¶
Volume Function /configWhere hydra should store config files. /downloadsNZB download folder.
Environment variables from files (Docker secrets)¶
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
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:
Application Setup¶
THIS IMAGE HAS BEEN DEPRECATED.
Please use linuxserver/nzbhydra2 instead.
The web interface is at <your ip>:5075 , to set up indexers and connections to your nzb download applications.
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 hydra /bin/bash- To monitor the logs of the container in realtime:
docker logs -f hydra- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' hydra- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/hydra
Versions¶
- 04.11.19: - Deprecated. Please use linuxserver/nzbhydra2 instead.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebasing to alpine 3.9.
- 11.02.19: - Add pipeline logic and multi arch.
- 17.08.18: - Rebase to alpine 3.8.
- 12.12.17: - Rebase to alpine 3.7.
- 20.07.17: - Internal git pull instead of at runtime.
- 25.05.17: - Rebase to alpine 3.6.
- 07.11.16: - Move git clone internal to the container,point config, database and log to use same locations for existing users.
- 14.10.16: - Add version layer information.
- 09.09.16: - Add layer badges to README.
- 28.08.16: - Add badges to README.
- 08.08.16: - Rebase to alpine linux.
- 25.01.16: - Initial Release.
\ No newline at end of file
+Application Setup¶
THIS IMAGE HAS BEEN DEPRECATED.
Please use linuxserver/nzbhydra2 instead.
The web interface is at <your ip>:5075 , to set up indexers and connections to your nzb download applications.
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 hydra /bin/bash- To monitor the logs of the container in realtime:
docker logs -f hydra- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' hydra- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/hydra
Versions¶
- 04.11.19: - Deprecated. Please use linuxserver/nzbhydra2 instead.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebasing to alpine 3.9.
- 11.02.19: - Add pipeline logic and multi arch.
- 17.08.18: - Rebase to alpine 3.8.
- 12.12.17: - Rebase to alpine 3.7.
- 20.07.17: - Internal git pull instead of at runtime.
- 25.05.17: - Rebase to alpine 3.6.
- 07.11.16: - Move git clone internal to the container,point config, database and log to use same locations for existing users.
- 14.10.16: - Add version layer information.
- 09.09.16: - Add layer badges to README.
- 28.08.16: - Add badges to README.
- 08.08.16: - Rebase to alpine linux.
- 25.01.16: - Initial Release.
DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. We will continue releases with a new image under the correct name: linuxserver/nzbhydra2.
linuxserver/hydra2¶
Hydra2 is a meta search application for NZB indexers, the "spiritual successor" to NZBmegasearcH, and an evolution of the original application NZBHydra.
It provides easy access to a number of raw and newznab based indexers. The application NZBHydra 2 is replacing NZBHydra 1 and supports migrating from V1. Be wary that there may be some compatibility issues for those migrating from V1 to V2, so ensure you back up your old configuration before moving over to the new version. NOTE: The last version that supports migration is linuxserver/hydra2:v2.10.2-ls49
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 linuxserver/hydra2 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 | amd64-latest |
| arm64 | arm64v8-latest |
| armhf | arm32v7-latest |
Version Tags¶
This image provides various versions that are available via tags. latest tag usually provides the latest stable version. Others are considered under development and caution must be exercised when using them.
| Tag | Description |
|---|---|
| latest | Stable releases |
| dev | Prereleases from their GitHub |
Usage¶
Here are some example snippets to help you get started creating a container from this image.
docker¶
docker create \
+ hydra2 - LinuxServer.io DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. We will continue releases with a new image under the correct name: linuxserver/nzbhydra2.
linuxserver/hydra2¶
Hydra2 is a meta search application for NZB indexers, the "spiritual successor" to NZBmegasearcH, and an evolution of the original application NZBHydra.
It provides easy access to a number of raw and newznab based indexers. The application NZBHydra 2 is replacing NZBHydra 1 and supports migrating from V1. Be wary that there may be some compatibility issues for those migrating from V1 to V2, so ensure you back up your old configuration before moving over to the new version. NOTE: The last version that supports migration is linuxserver/hydra2:v2.10.2-ls49
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 linuxserver/hydra2 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 amd64-latest arm64 arm64v8-latest armhf arm32v7-latest
Version Tags¶
This image provides various versions that are available via tags. latest tag usually provides the latest stable version. Others are considered under development and caution must be exercised when using them.
Tag Description latest Stable releases dev Prereleases from their GitHub
Usage¶
Here are some example snippets to help you get started creating a container from this image.
docker¶
docker create \
--name=hydra2 \
-e PUID=1000 \
-e PGID=1000 \
@@ -26,4 +26,4 @@
restart: unless-stopped
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 5076WebUI
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Europe/LondonSpecify a timezone to use EG Europe/London.
Volume Mappings (-v)¶
Volume Function /configWhere hydra2 should store config files. /downloadsNZB download folder.
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:
Application Setup¶
The web interface is at <your ip>:5076 , to set up indexers and connections to your nzb download applications.
Docker Mods¶
We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) can be accessed via the dynamic badge above.
Support Info¶
- Shell access whilst the container is running:
docker exec -it hydra2 /bin/bash- To monitor the logs of the container in realtime:
docker logs -f hydra2- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' hydra2- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/hydra2
Versions¶
- 19.04.20: - Deprecated. New repo at
linuxserver/docker-nzbhydra2. - 08.01.20: - Switch to python3.
- 05.01.20: - Add dev tag for prereleases.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 11.02.19: - Add pipeline logic and multi arch.
- 18.08.18: - Bump java version to 10, (bionic currently refers to it as version 11).
- 10.08.18: - Rebase to ubuntu bionic.
- 15.04.18: - Change to port 5076 in the Dockerfile.
- 11.01.18: - Initial Release.
\ No newline at end of file
+Application Setup¶
The web interface is at <your ip>:5076 , to set up indexers and connections to your nzb download applications.
Docker Mods¶
We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) can be accessed via the dynamic badge above.
Support Info¶
- Shell access whilst the container is running:
docker exec -it hydra2 /bin/bash- To monitor the logs of the container in realtime:
docker logs -f hydra2- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' hydra2- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/hydra2
Versions¶
- 19.04.20: - Deprecated. New repo at
linuxserver/docker-nzbhydra2. - 08.01.20: - Switch to python3.
- 05.01.20: - Add dev tag for prereleases.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 11.02.19: - Add pipeline logic and multi arch.
- 18.08.18: - Bump java version to 10, (bionic currently refers to it as version 11).
- 10.08.18: - Rebase to ubuntu bionic.
- 15.04.18: - Change to port 5076 in the Dockerfile.
- 11.01.18: - Initial Release.
DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. Please use the official IPFS container here: https://hub.docker.com/r/ipfs/go-ipfs When this project started the web interface was not integrated well with the default IPFS server. Now it is great and well maintained, hosting it on a static webserver does not make much sense anymore.
linuxserver/ipfs¶
Ipfs - A peer-to-peer hypermedia protocol designed to make the web faster, safer, and more open.
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/ipfs 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 | amd64-latest |
| arm64 | arm64v8-latest |
| armhf | arm32v7-latest |
Application Setup¶
In order to push files beyond your local gateway you have to make sure port 4001 is forwarded to the internet. This is required for IPFS peers to reach in and grab your files so public gateways can serve them.
Access the webui at http://localhost , if not using localhost scroll to the bottom of the page and set the API Address setting to IE http://192.168.1.10:5001 , from there you can upload and manage files you push to IPFS. Your gateway to access IPFS files is http://localhost:8080/ipfs/YOUR-FILE-HASH-HERE . You can also simply use public IPFS gateways like: * Cloudflare - https://cloudflare-ipfs.com/ipfs/YOUR-FILE-HASH-HERE * IPFS.io - https://ipfs.io/ipfs/YOUR-FILE-HASH-HERE * Eternum.io - https://ipfs.eternum.io/ipfs/YOUR-FILE-HASH-HERE
Cloudflare is a solid option as they actually edge cache the files on their CDN so even if your node pinning the item goes down for periods of time their cache will last up to a month.
For more on using IPFS please read the docs here
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)¶
---
+ ipfs - LinuxServer.io DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. Please use the official IPFS container here: https://hub.docker.com/r/ipfs/go-ipfs When this project started the web interface was not integrated well with the default IPFS server. Now it is great and well maintained, hosting it on a static webserver does not make much sense anymore.
linuxserver/ipfs¶
Ipfs - A peer-to-peer hypermedia protocol designed to make the web faster, safer, and more open.
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/ipfs 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 amd64-latest arm64 arm64v8-latest armhf arm32v7-latest
Application Setup¶
In order to push files beyond your local gateway you have to make sure port 4001 is forwarded to the internet. This is required for IPFS peers to reach in and grab your files so public gateways can serve them.
Access the webui at http://localhost , if not using localhost scroll to the bottom of the page and set the API Address setting to IE http://192.168.1.10:5001 , from there you can upload and manage files you push to IPFS. Your gateway to access IPFS files is http://localhost:8080/ipfs/YOUR-FILE-HASH-HERE . You can also simply use public IPFS gateways like: * Cloudflare - https://cloudflare-ipfs.com/ipfs/YOUR-FILE-HASH-HERE * IPFS.io - https://ipfs.io/ipfs/YOUR-FILE-HASH-HERE * Eternum.io - https://ipfs.eternum.io/ipfs/YOUR-FILE-HASH-HERE
Cloudflare is a solid option as they actually edge cache the files on their CDN so even if your node pinning the item goes down for periods of time their cache will last up to a month.
For more on using IPFS please read the docs here
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)¶
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 80The port for the IPFS web UI 4001Peering port, this is the only port you should expose to the internet 5001API port, the clientside webUI needs to be able to talk to this from whatever machine your web browser is on 8080Gateway Port, actually serves IPFS content 443HTTPS port for web UI
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Europe/LondonSpecify a timezone to use EG Europe/London
Volume Mappings (-v)¶
Volume Function /configIPFS storage and config files/logs
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:
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:
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 ipfs /bin/bash- To monitor the logs of the container in realtime:
docker logs -f ipfs- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' ipfs- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/ipfs
Versions¶
- 02.02.22: - Deprecate.
- 19.09.21: - Build webui from source. Update code formatting. Rebase to Alpine 3.14.
- 01.04.21: - Add migration bins to image to support upgrades.
- 24.02.20: - Rebase to Alpine 3.13.
- 09.07.19: - Initial version.
\ No newline at end of file
+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 ipfs /bin/bash- To monitor the logs of the container in realtime:
docker logs -f ipfs- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' ipfs- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/ipfs
Versions¶
- 02.02.22: - Deprecate.
- 19.09.21: - Build webui from source. Update code formatting. Rebase to Alpine 3.14.
- 01.04.21: - Add migration bins to image to support upgrades.
- 24.02.20: - Rebase to Alpine 3.13.
- 09.07.19: - Initial version.
linuxserver/jackett¶
Jackett works as a proxy server: it translates queries from apps (Sonarr, SickRage, CouchPotato, Mylar, etc) into tracker-site-specific http queries, parses the html response, then sends results back to the requesting software. This allows for getting recent uploads (like RSS) and performing searches. Jackett is a single repository of maintained indexer scraping & translation logic - removing the burden from other apps.
Supported Architectures¶
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/jackett:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
| Tag | Available | Description |
|---|---|---|
| latest | ✅ | Stable Jackett Releases |
| development | ✅ | Latest Jackett Releases |
| ## Application Setup |
The web interface is at <your-ip>:9117 , configure various trackers and connections to other apps there. More info at Jackett.
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)¶
---
+ jackett - LinuxServer.io linuxserver/jackett¶
Jackett works as a proxy server: it translates queries from apps (Sonarr, SickRage, CouchPotato, Mylar, etc) into tracker-site-specific http queries, parses the html response, then sends results back to the requesting software. This allows for getting recent uploads (like RSS) and performing searches. Jackett is a single repository of maintained indexer scraping & translation logic - removing the burden from other apps.
Supported Architectures¶
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/jackett:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
Tag Available Description latest ✅ Stable Jackett Releases development ✅ Latest Jackett Releases ## Application Setup
The web interface is at <your-ip>:9117 , configure various trackers and connections to other apps there. More info at Jackett.
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)¶
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 9117WebUI
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. AUTO_UPDATE=trueAllow Jackett to update inside of the container (currently recommended by Jackett and enabled by default) RUN_OPTS=Optionally specify additional arguments to be passed.
Volume Mappings (-v)¶
Volume Function /configWhere Jackett should store its config file. /downloadsPath to torrent blackhole.
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:
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:
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 jackett /bin/bash- To monitor the logs of the container in realtime:
docker logs -f jackett- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' jackett- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/jackett:latest
Versions¶
- 11.07.23: - Rebase to Alpine 3.18.
- 01.07.23: - Deprecate armhf. As announced here
- 13.02.23: - Add icu-data-full to address ICU issue with Cyrillic character sets.
- 11.02.23: - Rebase to Alpine 3.17, migrate to s6v3.
- 10.05.22: - Rebase to Ubuntu Focal.
- 24.05.20: - Allow user to optionally enable auto updates.
- 31.12.19: - Remove agressive startup chowning.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 10.03.19: - Switch to net-core builds of jackett, not dependant on mono and smaller images.
- 11.02.19: - Add pipeline logic and multi arch.
- 11.06.18: - Ensure root ownership of Jackett files.
- 13.12.17: - Fix continuation lines.
- 17.04.17: - Switch to using inhouse mono baseimage, ubuntu xenial based.
- 09.02.17: - Rebase to alpine 3.5.
- 29.10.16: - Call python2 from edge main to satisfy new mono dependency.
- 14.10.16: - Add version layer information.
- 22.09.16: - Remove autoupdate, tidy up Dockerfile.
- 10.09.16: - Add layer badges to README.
- 28.08.16: - Add badges to README.
- 06.08.16: - Rebase to alpine linux for smaller image.
- 25.01.16: - Initial Release.
\ No newline at end of file
+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 jackett /bin/bash- To monitor the logs of the container in realtime:
docker logs -f jackett- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' jackett- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/jackett:latest
Versions¶
- 11.07.23: - Rebase to Alpine 3.18.
- 01.07.23: - Deprecate armhf. As announced here
- 13.02.23: - Add icu-data-full to address ICU issue with Cyrillic character sets.
- 11.02.23: - Rebase to Alpine 3.17, migrate to s6v3.
- 10.05.22: - Rebase to Ubuntu Focal.
- 24.05.20: - Allow user to optionally enable auto updates.
- 31.12.19: - Remove agressive startup chowning.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 10.03.19: - Switch to net-core builds of jackett, not dependant on mono and smaller images.
- 11.02.19: - Add pipeline logic and multi arch.
- 11.06.18: - Ensure root ownership of Jackett files.
- 13.12.17: - Fix continuation lines.
- 17.04.17: - Switch to using inhouse mono baseimage, ubuntu xenial based.
- 09.02.17: - Rebase to alpine 3.5.
- 29.10.16: - Call python2 from edge main to satisfy new mono dependency.
- 14.10.16: - Add version layer information.
- 22.09.16: - Remove autoupdate, tidy up Dockerfile.
- 10.09.16: - Add layer badges to README.
- 28.08.16: - Add badges to README.
- 06.08.16: - Rebase to alpine linux for smaller image.
- 25.01.16: - Initial Release.
linuxserver/jellyfin¶
Jellyfin is a Free Software Media System that puts you in control of managing and streaming your media. It is an alternative to the proprietary Emby and Plex, to provide media from a dedicated server to end-user devices via multiple apps. Jellyfin is descended from Emby's 3.5.2 release and ported to the .NET Core framework to enable full cross-platform support. There are no strings attached, no premium licenses or features, and no hidden agendas: just a team who want to build something better and work together to achieve it.
Supported Architectures¶
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/jellyfin:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
| Tag | Available | Description |
|---|---|---|
| latest | ✅ | Stable Jellyfin releases |
| nightly | ✅ | Nightly Jellyfin releases |
| ## Application Setup |
Webui can be found at http://<your-ip>:8096
More information can be found on the official documentation here.
Hardware Acceleration¶
Intel¶
Hardware acceleration users for Intel Quicksync will need to mount their /dev/dri video device inside of the container by passing the following command when running or creating the container:
--device=/dev/dri:/dev/dri
We will automatically ensure the abc user inside of the container has the proper permissions to access this device.
To enable the OpenCL based DV, HDR10 and HLG tone-mapping, please refer to the OpenCL-Intel mod from here:
https://mods.linuxserver.io/?mod=jellyfin
Nvidia¶
Hardware acceleration users for Nvidia will need to install the container runtime provided by Nvidia on their host, instructions can be found here:
https://github.com/NVIDIA/nvidia-docker
We automatically add the necessary environment variable that will utilise all the features available on a GPU on the host. Once nvidia-docker is installed on your host you will need to re/create the docker container with the nvidia container runtime --runtime=nvidia and add an environment variable -e NVIDIA_VISIBLE_DEVICES=all (can also be set to a specific gpu's UUID, this can be discovered by running nvidia-smi --query-gpu=gpu_name,gpu_uuid --format=csv ). NVIDIA automatically mounts the GPU and drivers from your host into the jellyfin docker container.
OpenMAX (Raspberry Pi)¶
Hardware acceleration users for Raspberry Pi MMAL/OpenMAX will need to mount their /dev/vcsm and /dev/vchiq video devices inside of the container and their system OpenMax libs by passing the following options when running or creating the container:
--device=/dev/vcsm:/dev/vcsm
+ jellyfin - LinuxServer.io linuxserver/jellyfin¶
Jellyfin is a Free Software Media System that puts you in control of managing and streaming your media. It is an alternative to the proprietary Emby and Plex, to provide media from a dedicated server to end-user devices via multiple apps. Jellyfin is descended from Emby's 3.5.2 release and ported to the .NET Core framework to enable full cross-platform support. There are no strings attached, no premium licenses or features, and no hidden agendas: just a team who want to build something better and work together to achieve it.
Supported Architectures¶
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/jellyfin:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
Tag Available Description latest ✅ Stable Jellyfin releases nightly ✅ Nightly Jellyfin releases ## Application Setup
Webui can be found at http://<your-ip>:8096
More information can be found on the official documentation here.
Hardware Acceleration¶
Intel¶
Hardware acceleration users for Intel Quicksync will need to mount their /dev/dri video device inside of the container by passing the following command when running or creating the container:
--device=/dev/dri:/dev/dri
We will automatically ensure the abc user inside of the container has the proper permissions to access this device.
To enable the OpenCL based DV, HDR10 and HLG tone-mapping, please refer to the OpenCL-Intel mod from here:
https://mods.linuxserver.io/?mod=jellyfin
Nvidia¶
Hardware acceleration users for Nvidia will need to install the container runtime provided by Nvidia on their host, instructions can be found here:
https://github.com/NVIDIA/nvidia-docker
We automatically add the necessary environment variable that will utilise all the features available on a GPU on the host. Once nvidia-docker is installed on your host you will need to re/create the docker container with the nvidia container runtime --runtime=nvidia and add an environment variable -e NVIDIA_VISIBLE_DEVICES=all (can also be set to a specific gpu's UUID, this can be discovered by running nvidia-smi --query-gpu=gpu_name,gpu_uuid --format=csv ). NVIDIA automatically mounts the GPU and drivers from your host into the jellyfin docker container.
OpenMAX (Raspberry Pi)¶
Hardware acceleration users for Raspberry Pi MMAL/OpenMAX will need to mount their /dev/vcsm and /dev/vchiq video devices inside of the container and their system OpenMax libs by passing the following options when running or creating the container:
V4L2 (Raspberry Pi)¶
Hardware acceleration users for Raspberry Pi V4L2 will need to mount their /dev/video1X devices inside of the container by passing the following options when running or creating the container:
The official documentation for environmentals has additional environmentals that can provide additional configurability such as migrating to the native Jellyfin image.
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:
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 jellyfin /bin/bash- To monitor the logs of the container in realtime:
docker logs -f jellyfin- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' jellyfin- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/jellyfin:latest
Versions¶
- 04.07.23: - Deprecate armhf. As announced here
- 07.12.22: - Rebase master to Jammy, migrate to s6v3.
- 11.06.22: - Switch to upstream repo's ffmpeg5 build.
- 05.01.22: - Specify Intel iHD driver versions to avoid mismatched libva errors.
- 25.12.21: - Fix video device group perms error message.
- 10.12.21: - Rework readme, disable template sync.
- 22.09.21: - Pull only the server, web and ffmpeg packages instead of the wrapper.
- 23.06.21: - Add log message if device permissions are incorrect. Pin jellyfin dependency versions to prevent upstream apt repo issues. Deprecate the
bionic tag. - 21.05.21: - Add nvidia.icd file to fix missing tonemapping using Nvidia HW.
- 20.01.21: - Add Jellyfin Binary Environmentals
- 20.01.21: - Deprecate
UMASK_SET in favor of UMASK in baseimage, see above for more information. - 23.11.20: - Rebase to Focal, branch off Bionic.
- 22.07.20: - Ingest releases from Jellyfin repo.
- 28.04.20: - Replace MMAL/OMX dependency device
/dev/vc-mem with /dev/vcsm as the former was not sufficient for raspbian. - 11.04.20: - Enable hw decode (mmal) on Raspberry Pi, update readme instructions, add donation info, create missing default transcodes folder.
- 11.03.20: - Add Pi V4L2 support, remove optional transcode mapping (location is selected in the gui, defaults to path under
/config). - 30.01.20: - Add nightly tag.
- 09.01.20: - Add Pi OpenMax support.
- 02.10.19: - Improve permission fixing for render & dvb devices.
- 31.07.19: - Add AMD drivers for vaapi support on x86.
- 13.06.19: - Add Intel drivers for vaapi support on x86.
- 07.06.19: - Initial release.
\ No newline at end of file
+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 jellyfin /bin/bash- To monitor the logs of the container in realtime:
docker logs -f jellyfin- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' jellyfin- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/jellyfin:latest
Versions¶
- 04.07.23: - Deprecate armhf. As announced here
- 07.12.22: - Rebase master to Jammy, migrate to s6v3.
- 11.06.22: - Switch to upstream repo's ffmpeg5 build.
- 05.01.22: - Specify Intel iHD driver versions to avoid mismatched libva errors.
- 25.12.21: - Fix video device group perms error message.
- 10.12.21: - Rework readme, disable template sync.
- 22.09.21: - Pull only the server, web and ffmpeg packages instead of the wrapper.
- 23.06.21: - Add log message if device permissions are incorrect. Pin jellyfin dependency versions to prevent upstream apt repo issues. Deprecate the
bionictag. - 21.05.21: - Add nvidia.icd file to fix missing tonemapping using Nvidia HW.
- 20.01.21: - Add Jellyfin Binary Environmentals
- 20.01.21: - Deprecate
UMASK_SETin favor of UMASK in baseimage, see above for more information. - 23.11.20: - Rebase to Focal, branch off Bionic.
- 22.07.20: - Ingest releases from Jellyfin repo.
- 28.04.20: - Replace MMAL/OMX dependency device
/dev/vc-memwith/dev/vcsmas the former was not sufficient for raspbian. - 11.04.20: - Enable hw decode (mmal) on Raspberry Pi, update readme instructions, add donation info, create missing default transcodes folder.
- 11.03.20: - Add Pi V4L2 support, remove optional transcode mapping (location is selected in the gui, defaults to path under
/config). - 30.01.20: - Add nightly tag.
- 09.01.20: - Add Pi OpenMax support.
- 02.10.19: - Improve permission fixing for render & dvb devices.
- 31.07.19: - Add AMD drivers for vaapi support on x86.
- 13.06.19: - Add Intel drivers for vaapi support on x86.
- 07.06.19: - Initial release.
linuxserver/jenkins-builder¶
Expects to run as part of the LSIO CI process. Not for public consumption.
Running against remote project¶
docker run --rm \
+ jenkins-builder - LinuxServer.io linuxserver/jenkins-builder¶
Expects to run as part of the LSIO CI process. Not for public consumption.
Running against remote project¶
docker run --rm \
-e CONTAINER_NAME=${CONTAINER_NAME} \
-v ${TEMPDIR}:/ansible/jenkins \
lscr.io/linuxserver/jenkins-builder:latest
@@ -16,4 +16,4 @@
--pull \
-t lscr.io/linuxserver/jenkins-builder:latest .
The ARM variants can be built on x86_64 hardware using multiarch/qemu-user-static
Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.
Versions¶
The following line is only in this repo for loop testing:
- { date: "01.01.50:", desc: "I am the release message for this internal repo." }
\ No newline at end of file
+Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.
Versions¶
The following line is only in this repo for loop testing:
- { date: "01.01.50:", desc: "I am the release message for this internal repo." }
DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated.
linuxserver/kanzi¶
Kanzi, formerly titled Kodi-Alexa, this custom skill is the ultimate voice remote control for navigating Kodi. It can do anything you can think of (100+ intents). This container also contains lexigram-cli to setup Kanzi with an Amazon Developer Account and automatically deploy it to Amazon.
Supported Architectures¶
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/kanzi:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ✅ | arm32v7-<version tag> |
Application Setup¶
Initial setup¶
- Once you start the container for the first time, you need to perform some steps before use.
- Create an Amazon Developer Account here.
- Open a terminal in the
/configdirectory of the docker containerdocker exec -itw /config kanzi bash - Enter
lexigram login --no-browser trueto setup your AWS credentials and copy the URL into a browser, login to your Amazon Developer Account and copy/paste the resulting authorisation code back into the terminal and press enter. - Edit the file
kodi.configaccording to your local setup and this will be used by the included gunicorn server to respond to requests. - Restart the container to automatically deploy the Kanzi skill.
- Reverse proxy this container with our LetsEncrypt container which contains preconfigured templates for reverse proxying the Kanzi container on either a subdomain or subfolder utilising Docker custom networking. Alternatively, if you already have an Nginx reverse proxy set up, you can use one of these location blocks to reverse proxy Kanzi to a subfolder or subdomain respectively.
Subfolder
location /kanzi {
+ kanzi - LinuxServer.io DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated.
linuxserver/kanzi¶
Kanzi, formerly titled Kodi-Alexa, this custom skill is the ultimate voice remote control for navigating Kodi. It can do anything you can think of (100+ intents). This container also contains lexigram-cli to setup Kanzi with an Amazon Developer Account and automatically deploy it to Amazon.
Supported Architectures¶
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/kanzi:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ✅ arm32v7-<version tag>
Application Setup¶
Initial setup¶
- Once you start the container for the first time, you need to perform some steps before use.
- Create an Amazon Developer Account here.
- Open a terminal in the
/config directory of the docker container docker exec -itw /config kanzi bash - Enter
lexigram login --no-browser true to setup your AWS credentials and copy the URL into a browser, login to your Amazon Developer Account and copy/paste the resulting authorisation code back into the terminal and press enter. - Edit the file
kodi.config according to your local setup and this will be used by the included gunicorn server to respond to requests. - Restart the container to automatically deploy the Kanzi skill.
- Reverse proxy this container with our LetsEncrypt container which contains preconfigured templates for reverse proxying the Kanzi container on either a subdomain or subfolder utilising Docker custom networking. Alternatively, if you already have an Nginx reverse proxy set up, you can use one of these location blocks to reverse proxy Kanzi to a subfolder or subdomain respectively.
Subfolder
location /kanzi {
rewrite ^/kanzi/(.*) /$1 break;
proxy_pass https://$IP-ADDRESS:8000;
proxy_redirect https://$IP-ADDRESS:8000 /kanzi;
@@ -47,4 +47,4 @@
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 8000Application Port
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Europe/LondonSpecify a timezone to use EG Europe/London. INVOCATION_NAME=kanziSpecify an invocation name for this skill, use either kanzi or kod. URL_ENDPOINT=https://server.com/kanzi/Specify the URL at which the webserver is reachable either https://kanzi.server.com/ or https://server.com/kanzi/ Note the trailing slash MUST be included.
Volume Mappings (-v)¶
Volume Function /configConfiguration files.
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:
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:
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 kanzi /bin/bash- To monitor the logs of the container in realtime:
docker logs -f kanzi- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' kanzi- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/kanzi:latest
Versions¶
- 20.06.22: - Deprecate image.
- 13.04.19: - Initial Release.
\ No newline at end of file
+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 kanzi /bin/bash- To monitor the logs of the container in realtime:
docker logs -f kanzi- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' kanzi- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/kanzi:latest
Versions¶
- 20.06.22: - Deprecate image.
- 13.04.19: - Initial Release.
linuxserver/kasm¶
Kasm Workspaces is a docker container streaming platform for delivering browser-based access to desktops, applications, and web services. Kasm uses devops-enabled Containerized Desktop Infrastructure (CDI) to create on-demand, disposable, docker containers that are accessible via web browser. Example use-cases include Remote Browser Isolation (RBI), Data Loss Prevention (DLP), Desktop as a Service (DaaS), Secure Remote Access Services (RAS), and Open Source Intelligence (OSINT) collections.
The rendering of the graphical-based containers is powered by the open-source project KasmVNC.
Supported Architectures¶
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/kasm:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
| Tag | Available | Description |
|---|---|---|
| latest | ✅ | Stable Kasm releases |
| develop | ✅ | Tip of develop |
| ## Application Setup |
This container uses Docker in Docker and requires being run in privileged mode. This container also requires an initial setup that runs on port 3000.
Unlike other containers the web interface port (default 443) needs to be set for the env variable KASM_PORT and both the inside and outside port IE for 4443 KASM_PORT=4443 -p 4443:4443
Unraid users due to the DinD storage layer /opt/ should be mounted directly to a disk IE /mnt/disk1/appdata/path or optimally with a cache disk at /mnt/cache/appdata/path
Access the installation wizard at https://your ip:3000 and follow the instructions there. Once setup is complete access https://your ip:443 and login with the credentials you entered during setup. The default users are:
- admin@kasm.local
- user@kasm.local
Currently Synology systems are not supported due to them blocking CPU scheduling in their Kernel.
GPU Support¶
During installation an option will be presented to force all Workspace containers to mount in and use a specific GPU. If using an NVIDIA GPU you will need to pass -e NVIDIA_VISIBLE_DEVICES=all or --gpus all and have the NVIDIA Container Runtime installed on the host. Also if using NVIDIA, Kasm Workspaces has native NVIDIA support so you can optionally opt to simply use that instead of he manual override during installation.
Gamepad support¶
In order to properly create virtual Gamepads you will need to mount from your host /dev/input and /run/udev/data. Please see HERE for instructions on enabling gamepad support.
Persistant profiles¶
In order to use persistant profiles in Workspaces you will need to mount in a folder to use from your host to /profiles. From there when configuring a workspace you can set the Persistant Profile Path to IE /profiles/ubuntu-focal/{username}/, more infomation can be found HERE.
Reverse proxy¶
A sample for SWAG can be found here. Post installation you will need to modify the "Proxy Port" setting under the default zone to 0 as outlined here to launch Workspaces sessions.
Strict reverse proxies¶
This image uses a self-signed certificate by default. This naturally means the scheme is https. If you are using a reverse proxy which validates certificates, you need to disable this check for the container.
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)¶
---
+ kasm - LinuxServer.io linuxserver/kasm¶
Kasm Workspaces is a docker container streaming platform for delivering browser-based access to desktops, applications, and web services. Kasm uses devops-enabled Containerized Desktop Infrastructure (CDI) to create on-demand, disposable, docker containers that are accessible via web browser. Example use-cases include Remote Browser Isolation (RBI), Data Loss Prevention (DLP), Desktop as a Service (DaaS), Secure Remote Access Services (RAS), and Open Source Intelligence (OSINT) collections.
The rendering of the graphical-based containers is powered by the open-source project KasmVNC.
Supported Architectures¶
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/kasm:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
Tag Available Description latest ✅ Stable Kasm releases develop ✅ Tip of develop ## Application Setup
This container uses Docker in Docker and requires being run in privileged mode. This container also requires an initial setup that runs on port 3000.
Unlike other containers the web interface port (default 443) needs to be set for the env variable KASM_PORT and both the inside and outside port IE for 4443 KASM_PORT=4443 -p 4443:4443
Unraid users due to the DinD storage layer /opt/ should be mounted directly to a disk IE /mnt/disk1/appdata/path or optimally with a cache disk at /mnt/cache/appdata/path
Access the installation wizard at https://your ip:3000 and follow the instructions there. Once setup is complete access https://your ip:443 and login with the credentials you entered during setup. The default users are:
- admin@kasm.local
- user@kasm.local
Currently Synology systems are not supported due to them blocking CPU scheduling in their Kernel.
GPU Support¶
During installation an option will be presented to force all Workspace containers to mount in and use a specific GPU. If using an NVIDIA GPU you will need to pass -e NVIDIA_VISIBLE_DEVICES=all or --gpus all and have the NVIDIA Container Runtime installed on the host. Also if using NVIDIA, Kasm Workspaces has native NVIDIA support so you can optionally opt to simply use that instead of he manual override during installation.
Gamepad support¶
In order to properly create virtual Gamepads you will need to mount from your host /dev/input and /run/udev/data. Please see HERE for instructions on enabling gamepad support.
Persistant profiles¶
In order to use persistant profiles in Workspaces you will need to mount in a folder to use from your host to /profiles. From there when configuring a workspace you can set the Persistant Profile Path to IE /profiles/ubuntu-focal/{username}/, more infomation can be found HERE.
Reverse proxy¶
A sample for SWAG can be found here. Post installation you will need to modify the "Proxy Port" setting under the default zone to 0 as outlined here to launch Workspaces sessions.
Strict reverse proxies¶
This image uses a self-signed certificate by default. This naturally means the scheme is https. If you are using a reverse proxy which validates certificates, you need to disable this check for the container.
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:
kasm:
@@ -35,4 +35,4 @@
--restart unless-stopped \
lscr.io/linuxserver/kasm:latest
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 3000Kasm Installation wizard. (https) 443Kasm Workspaces interface. (https)
Environment Variables (-e)¶
Env Function KASM_PORT=443Specify the port you bind to the outside for Kasm Workspaces. DOCKER_HUB_USERNAME=USEROptionally specify a DockerHub Username to pull private images. DOCKER_HUB_PASSWORD=PASSOptionally specify a DockerHub password to pull private images. DOCKER_MTU=1500Optionally specify the mtu options passed to dockerd.
Volume Mappings (-v)¶
Volume Function /optDocker and installation storage. /profilesOptionally specify a path for persistent profile storage. /dev/inputOptional for gamepad support. /run/udev/dataOptional for gamepad support.
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:
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.
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 kasm /bin/bash- To monitor the logs of the container in realtime:
docker logs -f kasm- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' kasm- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/kasm:latest
Versions¶
- 22.08.23: - Update base image for 1.14.0 release.
- 07.04.23: - Add mod layer for ingesting LSIO images for 1.13.0 release.
- 28.03.23: - Pin compose to 2.5.0 to be in sync with upstream requirements.
- 05.11.22: - Rebase to Jammy, add support for GPUs, add support for Gamepads.
- 23.09.22: - Migrate to s6v3.
- 02.07.22: - Initial Release.
\ No newline at end of file
+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.
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 kasm /bin/bash- To monitor the logs of the container in realtime:
docker logs -f kasm- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' kasm- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/kasm:latest
Versions¶
- 22.08.23: - Update base image for 1.14.0 release.
- 07.04.23: - Add mod layer for ingesting LSIO images for 1.13.0 release.
- 28.03.23: - Pin compose to 2.5.0 to be in sync with upstream requirements.
- 05.11.22: - Rebase to Jammy, add support for GPUs, add support for Gamepads.
- 23.09.22: - Migrate to s6v3.
- 02.07.22: - Initial Release.
linuxserver/kavita¶
Kavita is a fast, feature rich, cross platform reading server. Built with a focus for being a full solution for all your reading needs. Setup your own server and share your reading collection with your friends and family!
Supported Architectures¶
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/kavita:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
Access the webui at <your-ip>:5000. Follow the setup wizard on initial install.
The docker cli and compose yml samples provided list a single /data folder for the media, however, you can set up multiple mount points if you wish. For instance, you can set up 3 separate mountpoints named /manga, /comics and /books, each mapped to separate folders on host.
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)¶
---
+ kavita - LinuxServer.io linuxserver/kavita¶
Kavita is a fast, feature rich, cross platform reading server. Built with a focus for being a full solution for all your reading needs. Setup your own server and share your reading collection with your friends and family!
Supported Architectures¶
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/kavita:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
Access the webui at <your-ip>:5000. Follow the setup wizard on initial install.
The docker cli and compose yml samples provided list a single /data folder for the media, however, you can set up multiple mount points if you wish. For instance, you can set up 3 separate mountpoints named /manga, /comics and /books, each mapped to separate folders on host.
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)¶
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 5000web gui
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configContains all relevant configuration files. /dataMedia library containing manga, comics and books.
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:
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:
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 kavita /bin/bash- To monitor the logs of the container in realtime:
docker logs -f kavita- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' kavita- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/kavita:latest
Versions¶
- 12.08.23: - Fix app file perms to prevent high uid.
- 07.08.23: - Initial Release.
\ No newline at end of file
+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 kavita /bin/bash- To monitor the logs of the container in realtime:
docker logs -f kavita- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' kavita- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/kavita:latest
Versions¶
- 12.08.23: - Fix app file perms to prevent high uid.
- 07.08.23: - Initial Release.
linuxserver/kdenlive¶
Kdenlive is a powerful free and open source cross-platform video editing program made by the KDE community. Feature rich and production ready.
Supported Architectures¶
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/kdenlive:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
The application can be accessed at:
- http://yourhost:3000/
- https://yourhost:3001/
Hardware Acceleration (x86_64 only)¶
In order to perform hardware transcoding you will need to mount a video device into the container. Some of the default hardware rendering/transcode profiles will point to devices in /dev/dri for vaapi_device. Make sure the profile you are using points to the correct device in the container. IE if you have intel integrated graphics along with an Nvdia or AMD video card you might have renderD128, renderD129, etc. To check which device is which use vainfo from inside the container: (right click the desktop and open xterm)
vainfo --display drm --device /dev/dri/renderD128
+ kdenlive - LinuxServer.io linuxserver/kdenlive¶
Kdenlive is a powerful free and open source cross-platform video editing program made by the KDE community. Feature rich and production ready.
Supported Architectures¶
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/kdenlive:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
The application can be accessed at:
- http://yourhost:3000/
- https://yourhost:3001/
Hardware Acceleration (x86_64 only)¶
In order to perform hardware transcoding you will need to mount a video device into the container. Some of the default hardware rendering/transcode profiles will point to devices in /dev/dri for vaapi_device. Make sure the profile you are using points to the correct device in the container. IE if you have intel integrated graphics along with an Nvdia or AMD video card you might have renderD128, renderD129, etc. To check which device is which use vainfo from inside the container: (right click the desktop and open xterm)
Nvidia¶
Hardware acceleration users for Nvidia will need to install the container runtime provided by Nvidia on their host, instructions can be found here: https://github.com/NVIDIA/nvidia-docker
We automatically add the necessary environment variable that will utilise all the features available on a GPU on the host. Once nvidia-docker is installed on your host you will need to re/create the docker container with the nvidia container runtime --runtime=nvidia and add an environment variable -e NVIDIA_VISIBLE_DEVICES=all (can also be set to a specific gpu's UUID, this can be discovered by running nvidia-smi --query-gpu=gpu_name,gpu_uuid --format=csv ). NVIDIA automatically mounts the GPU and drivers from your host into the container.
Options in all KasmVNC based GUI containers¶
This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.
Optional environment variables¶
Variable Description CUSTOM_PORT Internal port the container listens on for http if it needs to be swapped from the default 3000. CUSTOM_HTTPS_PORT Internal port the container listens on for https if it needs to be swapped from the default 3001. CUSTOM_USER HTTP Basic auth username, abc is default. PASSWORD HTTP Basic auth password, abc is default. If unset there will be no auth SUBFOLDER Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/ TITLE The page title displayed on the web browser, default "KasmVNC Client". FM_HOME This is the home directory (landing) for the file manager, default "/config". START_DOCKER If set to false a container with privilege will not automatically start the DinD Docker setup. DRINODE If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE /dev/dri/renderD128
Optional run configurations¶
Variable Description --privilegedWill start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE -v /home/user/docker-data:/var/lib/docker. -v /var/run/docker.sock:/var/run/docker.sockMount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. --device /dev/dri:/dev/driMount a GPU into the container, this can be used in conjunction with the DRINODE environment variable to leverage a host video card for GPU accelerated appplications. Only Open Source drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau)
Lossless mode¶
This container is capable of delivering a true lossless image at a high framerate to your web browser by changing the Stream Quality preset to "Lossless", more information here. In order to use this mode from a non localhost endpoint the HTTPS port on 3001 needs to be used. If using a reverse proxy to port 3000 specific headers will need to be set as outlined here.
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)¶
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 3000Kdenlive desktop gui 3001Kdenlive desktop gui HTTPS
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. SUBFOLDER=/Specify a subfolder to use with reverse proxies, IE /subfolder/
Volume Mappings (-v)¶
Volume Function /configUsers home directory in the container, stores local files and settings
Device Mappings (--device)¶
Parameter Function /dev/driAdd this for hardware acceleration (Linux hosts only)
Miscellaneous Options¶
Parameter Function --shm-size=This might be needed to prevent crashing --security-opt seccomp=unconfinedFor Docker Engine only, this may be required depending on your Docker and storage configuration.
Environment variables from files (Docker secrets)¶
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
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:
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 kdenlive /bin/bash- To monitor the logs of the container in realtime:
docker logs -f kdenlive- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' kdenlive- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/kdenlive:latest
Versions¶
- 24.04.23: - Ensure application launches in fullscreen.
- 18.03.23: - Rebase to KasmVNC base image.
- 16.09.22: - Migrate to s6v3.
- 09.03.22: - Update seccomp explanation.
- 07.03.22: - Initial release.
\ No newline at end of file
+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 kdenlive /bin/bash- To monitor the logs of the container in realtime:
docker logs -f kdenlive- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' kdenlive- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/kdenlive:latest
Versions¶
- 24.04.23: - Ensure application launches in fullscreen.
- 18.03.23: - Rebase to KasmVNC base image.
- 16.09.22: - Migrate to s6v3.
- 09.03.22: - Update seccomp explanation.
- 07.03.22: - Initial release.
linuxserver/kimai¶
Kimai is a professional grade time-tracking application, free and open-source. It handles use-cases of freelancers as well as companies with dozens or hundreds of users. Kimai was build to track your project times and ships with many advanced features, including but not limited to:
JSON API, invoicing, data exports, multi-timer and punch-in punch-out mode, tagging, multi-user - multi-timezones - multi-language (over 30 translations existing!), authentication via SAML/LDAP/Database, two-factor authentication (2FA) with TOTP, customizable role and team permissions, responsive design, user/customer/project specific rates, advanced search & filtering, money and time budgets, advanced reporting, support for plugins and so much more.
Supported Architectures¶
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/kimai:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
Configure your database connection¶
You have to replace the following values with your defaults:
- the database username "your_db_user"
- the database password "your_db_pass"
- the database schema name "your_db_name"
- the database host or IP "your_db_host"
- the database character set "your_db_charset" (usually "utf8")
- the database version "your_db_version"
- run
SELECT VERSION();in your MariaDB/MySQL database to get the version - example for MariaDB use "10.11.4-MariaDB-log"
- example for MySQL use "8.0.32"
- you might have to adapt port "3306" as well
DATABASE_URL=mysql://your_db_user:your_db_pass@your_db_host:3306/your_db_name?charset=your_db_charset&serverVersion=your_db_version
+ kimai - LinuxServer.io linuxserver/kimai¶
Kimai is a professional grade time-tracking application, free and open-source. It handles use-cases of freelancers as well as companies with dozens or hundreds of users. Kimai was build to track your project times and ships with many advanced features, including but not limited to:
JSON API, invoicing, data exports, multi-timer and punch-in punch-out mode, tagging, multi-user - multi-timezones - multi-language (over 30 translations existing!), authentication via SAML/LDAP/Database, two-factor authentication (2FA) with TOTP, customizable role and team permissions, responsive design, user/customer/project specific rates, advanced search & filtering, money and time budgets, advanced reporting, support for plugins and so much more.
Supported Architectures¶
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/kimai:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
Configure your database connection¶
You have to replace the following values with your defaults:
- the database username "your_db_user"
- the database password "your_db_pass"
- the database schema name "your_db_name"
- the database host or IP "your_db_host"
- the database character set "your_db_charset" (usually "utf8")
- the database version "your_db_version"
- run
SELECT VERSION(); in your MariaDB/MySQL database to get the version - example for MariaDB use "10.11.4-MariaDB-log"
- example for MySQL use "8.0.32"
- you might have to adapt port "3306" as well
DATABASE_URL=mysql://your_db_user:your_db_pass@your_db_host:3306/your_db_name?charset=your_db_charset&serverVersion=your_db_version
````
### Create your first user
@@ -69,4 +69,4 @@
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 80http gui 443https gui
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. DATABASE_URL=mysql://your_db_user:your_db_pass@your_db_host:3306/your_db_name?charset=your_db_charset&serverVersion=your_db_versionConfigure your database connection, see Application Setup instructions.
Volume Mappings (-v)¶
Volume Function /configConfiguration files.
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:
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:
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 kimai /bin/bash- To monitor the logs of the container in realtime:
docker logs -f kimai- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' kimai- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/kimai:latest
Versions¶
- 21.08.23: - Important documentation update for setting
DATABASE_URL with version 2.0.30 and later. - 09.08.23: - Initial Release.
\ No newline at end of file
+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 kimai /bin/bash- To monitor the logs of the container in realtime:
docker logs -f kimai- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' kimai- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/kimai:latest
Versions¶
- 21.08.23: - Important documentation update for setting
DATABASE_URLwith version 2.0.30 and later. - 09.08.23: - Initial Release.
linuxserver/lazylibrarian¶
Lazylibrarian is a program to follow authors and grab metadata for all your digital reading needs. It uses a combination of Goodreads Librarything and optionally GoogleBooks as sources for author info and book info. This container is based on the DobyTang fork.
Supported Architectures¶
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/lazylibrarian:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
Access the webui at http://<your-ip>:5299/home, for more information check out Lazylibrarian.
Calibredb import¶
64bit only We have implemented the optional ability to pull in the dependencies to enable the Calibredb import program:, this means if you don't require this feature the container isn't uneccessarily bloated but should you require it, it is easily available. This optional layer will be rebuilt automatically on our CI pipeline upon new Calibre releases so you can stay up to date. To use this option add the optional environmental variable as detailed in the docker-mods section to pull an addition docker layer to enable ebook conversion and then in the LazyLibrarian config page (Processing:Calibredb import program:) set the path to converter tool to /usr/bin/calibredb
ffmpeg¶
By adding linuxserver/mods:lazylibrarian-ffmpeg to your DOCKER_MODS environment variable you can install ffmpeg into your container on startup. This allows you to use the audiobook conversion features of LazyLibrarian. You can enable it in the Web UI under Settings > Processing > External Programs by setting the ffmpeg path to ffmpeg.
Media folders¶
We have set /books as optional path, this is because it is the easiest way to get started. While easy to use, it has some drawbacks. Mainly losing the ability to hardlink (TL;DR a way for a file to exist in multiple places on the same file system while only consuming one file worth of space), or atomic move (TL;DR instant file moves, rather than copy+delete) files while processing content.
Use the optional path if you dont understand, or dont want hardlinks/atomic moves.
The folks over at servarr.com wrote a good write-up on how to get started with this.
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)¶
---
+ lazylibrarian - LinuxServer.io linuxserver/lazylibrarian¶
Lazylibrarian is a program to follow authors and grab metadata for all your digital reading needs. It uses a combination of Goodreads Librarything and optionally GoogleBooks as sources for author info and book info. This container is based on the DobyTang fork.
Supported Architectures¶
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/lazylibrarian:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
Access the webui at http://<your-ip>:5299/home, for more information check out Lazylibrarian.
Calibredb import¶
64bit only We have implemented the optional ability to pull in the dependencies to enable the Calibredb import program:, this means if you don't require this feature the container isn't uneccessarily bloated but should you require it, it is easily available. This optional layer will be rebuilt automatically on our CI pipeline upon new Calibre releases so you can stay up to date. To use this option add the optional environmental variable as detailed in the docker-mods section to pull an addition docker layer to enable ebook conversion and then in the LazyLibrarian config page (Processing:Calibredb import program:) set the path to converter tool to /usr/bin/calibredb
ffmpeg¶
By adding linuxserver/mods:lazylibrarian-ffmpeg to your DOCKER_MODS environment variable you can install ffmpeg into your container on startup. This allows you to use the audiobook conversion features of LazyLibrarian. You can enable it in the Web UI under Settings > Processing > External Programs by setting the ffmpeg path to ffmpeg.
Media folders¶
We have set /books as optional path, this is because it is the easiest way to get started. While easy to use, it has some drawbacks. Mainly losing the ability to hardlink (TL;DR a way for a file to exist in multiple places on the same file system while only consuming one file worth of space), or atomic move (TL;DR instant file moves, rather than copy+delete) files while processing content.
Use the optional path if you dont understand, or dont want hardlinks/atomic moves.
The folks over at servarr.com wrote a good write-up on how to get started with this.
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)¶
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 5299The port for the LazyLibrarian webinterface
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. DOCKER_MODS=linuxserver/calibre-web:calibre|linuxserver/mods:lazylibrarian-ffmpegAllows additional functionality to be added, e.g. the Calibredb import program (optional, more info below)
Volume Mappings (-v)¶
Volume Function /configLazyLibrarian config /downloadsDownload location /booksBooks location
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:
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:
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 lazylibrarian /bin/bash- To monitor the logs of the container in realtime:
docker logs -f lazylibrarian- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lazylibrarian- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/lazylibrarian:latest
Versions¶
- 10.08.23: - Bump unrar to 6.2.10.
- 01.07.23: - Deprecate armhf. As announced here
- 07.12.22: - Rebase to Ubuntu Jammy, migrate to s6v3. Use pyproject.toml for deps. Build unrar from source.
- 27.09.22: - Switch to
Levenshtein, add cmake as build dep on armhf. - 07.05.22: - Rebase to Ubuntu Focal.
- 22.05.21: - Make the paths clearer to the user, remove optional volume.
- 17.05.21: - Add linuxserver wheel index.
- 23.10.19: - Changed gitlab download link.
- 23.10.19: - Add python module Pillow.
- 31.07.19: - Add pyopenssl, remove git dependency during build time.
- 09.07.19: - Rebase to Ubuntu Bionic, enables Calibre docker mod.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 05.03.19: - Added apprise python package.
- 22.02.19: - Rebasing to alpine 3.9.
- 10.12.18: - Moved to Pipeline Building
- 16.08.18: - Rebase to alpine 3.8
- 05.01.18: - Deprecate cpu_core routine lack of scaling
- 12.12.17: - Rebase to alpine 3.7
- 21.07.17: - Internal git pull instead of at runtime
- 25.05.17: - Rebase to alpine 3.6
- 07.02.17: - Rebase to alpine 3.5
- 30.01.17: - Compile libunrar.so to allow reading of .cbr format files
- 12.01.17: - Add ghostscript package, allows magazine covers to be created etc
- 14.10.16: - Add version layer information
- 03.10.16: - Fix non-persistent settings and make log folder
- 28.09.16: - Inital Release
\ No newline at end of file
+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 lazylibrarian /bin/bash- To monitor the logs of the container in realtime:
docker logs -f lazylibrarian- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lazylibrarian- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/lazylibrarian:latest
Versions¶
- 10.08.23: - Bump unrar to 6.2.10.
- 01.07.23: - Deprecate armhf. As announced here
- 07.12.22: - Rebase to Ubuntu Jammy, migrate to s6v3. Use pyproject.toml for deps. Build unrar from source.
- 27.09.22: - Switch to
Levenshtein, add cmake as build dep on armhf. - 07.05.22: - Rebase to Ubuntu Focal.
- 22.05.21: - Make the paths clearer to the user, remove optional volume.
- 17.05.21: - Add linuxserver wheel index.
- 23.10.19: - Changed gitlab download link.
- 23.10.19: - Add python module Pillow.
- 31.07.19: - Add pyopenssl, remove git dependency during build time.
- 09.07.19: - Rebase to Ubuntu Bionic, enables Calibre docker mod.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 05.03.19: - Added apprise python package.
- 22.02.19: - Rebasing to alpine 3.9.
- 10.12.18: - Moved to Pipeline Building
- 16.08.18: - Rebase to alpine 3.8
- 05.01.18: - Deprecate cpu_core routine lack of scaling
- 12.12.17: - Rebase to alpine 3.7
- 21.07.17: - Internal git pull instead of at runtime
- 25.05.17: - Rebase to alpine 3.6
- 07.02.17: - Rebase to alpine 3.5
- 30.01.17: - Compile libunrar.so to allow reading of .cbr format files
- 12.01.17: - Add ghostscript package, allows magazine covers to be created etc
- 14.10.16: - Add version layer information
- 03.10.16: - Fix non-persistent settings and make log folder
- 28.09.16: - Inital Release
linuxserver/ldap-auth¶
Ldap-auth software is for authenticating users who request protected resources from servers proxied by nginx. It includes a daemon (ldap-auth) that communicates with an authentication server, and a webserver daemon that generates an authentication cookie based on the user’s credentials. The daemons are written in Python for use with a Lightweight Directory Access Protocol (LDAP) authentication server (OpenLDAP or Microsoft Windows Active Directory 2003 and 2012).
Supported Architectures¶
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/ldap-auth:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
- This container itself does not have any settings and it relies on the pertinent information passed through in http headers of incoming requests. Make sure that your webserver is set up with the right config.
- Here's a sample config: nginx-ldap-auth.conf.
- Unlike the upstream project, this image encodes the cookie information with fernet, using a randomly generated key during container creation (or optionally user defined).
- Also unlike the upstream project, this image serves the login page at
/ldaplogin(as well as/login) to prevent clashes with reverse proxied apps that may also use/loginfor their internal auth.
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)¶
---
+ ldap-auth - LinuxServer.io linuxserver/ldap-auth¶
Ldap-auth software is for authenticating users who request protected resources from servers proxied by nginx. It includes a daemon (ldap-auth) that communicates with an authentication server, and a webserver daemon that generates an authentication cookie based on the user’s credentials. The daemons are written in Python for use with a Lightweight Directory Access Protocol (LDAP) authentication server (OpenLDAP or Microsoft Windows Active Directory 2003 and 2012).
Supported Architectures¶
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/ldap-auth:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
- This container itself does not have any settings and it relies on the pertinent information passed through in http headers of incoming requests. Make sure that your webserver is set up with the right config.
- Here's a sample config: nginx-ldap-auth.conf.
- Unlike the upstream project, this image encodes the cookie information with fernet, using a randomly generated key during container creation (or optionally user defined).
- Also unlike the upstream project, this image serves the login page at
/ldaplogin (as well as /login) to prevent clashes with reverse proxied apps that may also use /login for their internal auth.
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:
ldap-auth:
@@ -22,4 +22,4 @@
--restart unless-stopped \
lscr.io/linuxserver/ldap-auth:latest
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 8888the port for ldap auth daemon 9000the port for ldap login page
Environment Variables (-e)¶
Env Function FERNETKEY=Optionally define a custom valid fernet key (only needed if container is frequently recreated, or if using multi-node setups, invalidating previous authentications) CERTFILE=Optionally point this to a certificate file to enable HTTP over SSL (HTTPS) for the ldap auth daemon KEYFILE=Optionally point this to the private key file, matching the certificate file referred to in CERTFILE
Volume Mappings (-v)¶
Volume Function
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:
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.
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 ldap-auth /bin/bash- To monitor the logs of the container in realtime:
docker logs -f ldap-auth- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' ldap-auth- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/ldap-auth:latest
Versions¶
- 20.06.23: - Sync upstream changes, including the ability to disable referrals with
X-Ldap-DisableReferrals. - 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 30.12.22: - Rebase to alpine 3.17.
- 19.09.22: - Rebase to alpine 3.15.
- 14.05.21: - Add linuxserver wheel index.
- 12.02.21: - Clean up cargo/rust cache.
- 10.02.21: - Rebasing to alpine 3.13.
- 08.09.20: - Set form action correctly.
- 30.07.20: - Fix bug related to unset optional
CERTFILE and KEYFILE vars. - 27.07.20: - Add support for HTTP over SSL (HTTPS).
- 21.07.20: - Add support for optional user defined fernet key.
- 02.06.20: - Rebasing to alpine 3.12, serve login page at
/ldaplogin as well as /login, to prevent clashes with reverese proxied apps. - 17.05.20: - Add support for self-signed CA certs.
- 20.02.20: - Switch to python3.
- 19.12.19: - Rebasing to alpine 3.11.
- 01.07.19: - Fall back to base64 encoding when basic http auth is used.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebasing to alpine 3.9.
- 18.09.18: - Update pip
- 14.09.18: - Add TZ parameter, remove unnecessary PUID/PGID params
- 11.08.18: - Initial release.
\ No newline at end of file
+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.
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 ldap-auth /bin/bash- To monitor the logs of the container in realtime:
docker logs -f ldap-auth- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' ldap-auth- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/ldap-auth:latest
Versions¶
- 20.06.23: - Sync upstream changes, including the ability to disable referrals with
X-Ldap-DisableReferrals. - 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 30.12.22: - Rebase to alpine 3.17.
- 19.09.22: - Rebase to alpine 3.15.
- 14.05.21: - Add linuxserver wheel index.
- 12.02.21: - Clean up cargo/rust cache.
- 10.02.21: - Rebasing to alpine 3.13.
- 08.09.20: - Set form action correctly.
- 30.07.20: - Fix bug related to unset optional
CERTFILEandKEYFILEvars. - 27.07.20: - Add support for HTTP over SSL (HTTPS).
- 21.07.20: - Add support for optional user defined fernet key.
- 02.06.20: - Rebasing to alpine 3.12, serve login page at
/ldaploginas well as/login, to prevent clashes with reverese proxied apps. - 17.05.20: - Add support for self-signed CA certs.
- 20.02.20: - Switch to python3.
- 19.12.19: - Rebasing to alpine 3.11.
- 01.07.19: - Fall back to base64 encoding when basic http auth is used.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebasing to alpine 3.9.
- 18.09.18: - Update pip
- 14.09.18: - Add TZ parameter, remove unnecessary PUID/PGID params
- 11.08.18: - Initial release.
DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated.
IMPORTANT NOTICE: THIS IMAGE HAS BEEN DEPRECATED AND THE PROJECT IS MOVED TO A NEW REPO¶
Due to a trademark related request, this image is moved to a new repo on Docker Hub and GitHub. This is a breaking change and you need to manually update. Apologies for the the disruption.
Switching existing implementations over to the new image is very easy, just follow these simple steps: https://github.com/linuxserver/docker-swag#migrating-from-the-old-linuxserverletsencrypt-image
This repository will be archived and builds for the image will no longer be created at the end of 2020¶
linuxserver/letsencrypt¶
SWAG - Secure Web-server And Gateway (formerly known as letsencrypt, no relation to Let's Encrypt™) sets up an Nginx webserver and reverse proxy with php support and a built-in certbot client that automates free SSL server certificate generation and renewal processes. It also contains fail2ban for intrusion prevention.
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 linuxserver/letsencrypt 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 | amd64-latest |
| arm64 | arm64v8-latest |
| armhf | arm32v7-latest |
Usage¶
Here are some example snippets to help you get started creating a container.
docker¶
docker create \
+ letsencrypt - LinuxServer.io DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated.
IMPORTANT NOTICE: THIS IMAGE HAS BEEN DEPRECATED AND THE PROJECT IS MOVED TO A NEW REPO¶
Due to a trademark related request, this image is moved to a new repo on Docker Hub and GitHub. This is a breaking change and you need to manually update. Apologies for the the disruption.
Switching existing implementations over to the new image is very easy, just follow these simple steps: https://github.com/linuxserver/docker-swag#migrating-from-the-old-linuxserverletsencrypt-image
This repository will be archived and builds for the image will no longer be created at the end of 2020¶
linuxserver/letsencrypt¶
SWAG - Secure Web-server And Gateway (formerly known as letsencrypt, no relation to Let's Encrypt™) sets up an Nginx webserver and reverse proxy with php support and a built-in certbot client that automates free SSL server certificate generation and renewal processes. It also contains fail2ban for intrusion prevention.
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 linuxserver/letsencrypt 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 amd64-latest arm64 arm64v8-latest armhf arm32v7-latest
Usage¶
Here are some example snippets to help you get started creating a container.
docker¶
docker create \
--name=swag \
--cap-add=NET_ADMIN \
-e PUID=1000 \
@@ -61,4 +61,4 @@
--pull \
-t linuxserver/letsencrypt:latest .
The ARM variants can be built on x86_64 hardware using multiarch/qemu-user-static
Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.
Versions¶
- 28.07.20: - Start transition to new name, SWAG.
- 17.06.20: - Reformat ssl.conf. Pull in pre-generated dhparams.pem from DO Spaces. Deprecate
DHLEVEL param. - 01.06.20: - Rebasing to alpine 3.12, change ldap login address to
/ldaplogin to avoid clashes (existing users need to manually update). - 31.05.20: - Tweak Authelia confs (existing users can delete
authelia-server.conf and authelia-location.conf, and restart to update). - 23.05.20: - Add support for Authelia.
- 15.05.20: - Remove
php7-pecl-imagick due to upstream issues. Add support for Geoip2 auto db retrieval. - 10.05.20: - Added support for fail2ban deny statements.
- 04.05.20: - Allow for optionally setting propagation time for dns plugins. Add repo version of
whois to replace the built-in busybox version. Update jail.local to change default fail2ban ban action to more widely supported iptables-allports. - 13.04.20: - Update cloudflare.ini with token info.
- 11.03.20: - Add php7-sodium.
- 06.03.20: - Implement cert renewal attempt during container start (only if the cert is already expired or will expire within the next 24 hours, otherwise it will be attempted at 2:08am).
- 05.03.20: - Use port and proto upstream variables for ldap and default sample confs.
- 24.02.20: - Remove world/group read permissions in dns-conf.
- 23.02.20: - Add aliyun dns validation plugin.
- 28.01.20: - Deprecate tls-sni validation method, remove from docs.
- 27.01.20: - Add support for cpanel dns validation.
- 10.01.20: - Add support for domeneshop dns validation.
- 07.01.20: - Update ciphers from Mozilla ssl-config recommendations.
- 01.01.20: - Add support for gandi dns validation.
- 31.12.19: - GeoIP2 databases now require personal license keys to download. Auto download is disabled and log message is added.
- 19.12.19: - Rebasing to alpine 3.11.
- 19.12.19: - Increase large_client_header_buffers in nginx.conf to prevent 414 errors.
- 18.12.19: - Add php7-imap and php7-pecl-apcu.
- 11.12.19: - Fix Google Cloud DNS to use .json file for authentication.
- 20.11.19: - Fix cryptography version mismatch due to pip issue.
- 17.11.19: - Add php7-pdo_odbc.
- 17.11.19: - Add transip dns validation plugin.
- 27.10.19: - Turn off lua resty core to get rid of error message in the log (existing users will have to delete
/config/nginx/nginx.conf and restart the container). - 26.10.19: - Add new package for stream-geoip2, remove geoip2 module patch.
- 24.10.19: - Add php7-pecl-imagick.
- 23.10.19: - Update Host header in
proxy.conf to fix CSRF issues. - 12.10.19: - Add linode dns validation plugin.
- 23.09.19: - Move GeoIP2 db to /config to make it persistent.
- 14.08.19: - Add inwx dns validation plugin.
- 06.08.19: - Add php7-ftp.
- 04.08.19: - Add php7-bcmath, php7-pear, php7-xmlrpc.
- 02.08.19: - Add php7-ldap, remove geoip v1(deprecated).
- 01.08.19: - Mark https redirect block as default_server (effective only for new installs).
- 31.07.19: - Create GeoIP2 databse (libmaxminddb) during container start if it doesn't exist.
- 30.07.19: - Support main domain via duckdns validation.
- 29.07.19: - Enable http to https redirect by default (effective only for new installs).
- 01.07.19: - Patch geoip2 module until upstream is fixed.
- 30.06.19: - Add geoip2 module.
- 28.06.19: - Rebasing to alpine 3.10.
- 19.06.19: - Set resolver to docker dns in ssl.conf.
- 29.05.19: - Compensate for changes to the reverse-proxy-confs repo.
- 26.05.19: - Remove botocore/urllib patch.
- 08.05.19: - Remove default.conf when nginx is upgraded in downstream image.
- 30.04.19: - Add php-redis.
- 12.04.19: - Rebase aarch64 image to 3.9.
- 25.03.19: - Rebase aarch64 image back to 3.8 due to python issues (specifically with fail2ban), switch packages to python 3 on amd64 and armhf, clean up pip/python cache to shrink image size.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 10.03.19: - Add TLSv1.3 to ssl.conf.
- 02.03.19: - Add php intl and posix modules.
- 27.02.19: - Add gnupg package.
- 22.02.19: - Rebase to alpine 3.9.
- 03.02.19: - Removed memcached due to seccomp errors. Let us know if you need to re-enable memcached.
- 28.01.19: - Add pipeline logic and multi arch.
- 21.01.19: - Remove client_body_max from proxy.conf (existing users need to manually update).
- 09.01.19: - Remove tls v1 and v1.1 from default ssl.conf, update ciphers (existing users need to manually update).
- 30.12.18: - Fix bundle key generation.
- 19.12.18: - Add ipv6 and http/2 support to default site config.
- 08.12.18: - Had to remove cert renewal during container start due to certbot's new undocumented
feature of up to 8 minute random delay. - 03.12.18: - Fix silly bug resetting the duckdns token.
- 02.12.18: - Add dns validation support for ovh.
- 20.11.18: - Externalize reverse proxy confs to separate github repo
linuxserver/reverse-proxy-confs, update baseimage packages during build - 19.11.18: - Add php opcache package.
- 12.11.18: - Add support for duckdns wildcard certs via dns validation
- 31.10.18: - Add various preset proxy confs and fix others (thanks @nemchik and @hijxf)
- 02.10.18: - Fix fail2ban instructions and logrotate conf
- 11.09.18: - Add various preset proxy confs and fix others (thanks @nemchik and @LeoVerto)
- 04.09.18: - Linting fixes.
- 30.08.18: - Add support for ldap auth, add proxy confs for bazarr, couchpotato, headphones, lidarr and plex subfolder (thanks @nemchik and @jedahan)
- 21.08.18: - Rebase to alpine 3.8, add info on search engine de-listing
- 08.08.18: - Add subdomain proxy conf for plex, update emby proxy confs
- 25.07.18: - Add subdomain proxy conf for syncthing
- 23.07.18: - Remove backwards compatibility and set default validation method to http. Update portainer proxy config to fix websockets. Add unifi proxy conf.
- 31.05.18: - Update ssl.conf and proxy.conf for tighter security (thanks @nemchik)
- 30.05.18: - Add reverse proxy configs for jackett, monitorr, nzbget, nzbletsencrypt, organizr, portainer and transmission (thanks @nemchik)
- 18.05.18: - Add more info on certs and unraid reverse proxy config
- 11.05.18: - Add php pgsql support
- 24.04.18: - Auto generate a private key + fullchain bundle pem that is needed by certain apps
- 20.04.18: - Add standardized optional reverse proxy conf files
- 19.04.18: - Bind memcached to localhost only, add php7-sqlite3
- 08.04.18: - Fix renewal hooks
- 29.03.18: - Create pfx cert after renewal for dns validation (previous version only created it for http and tls, an oversight)
- 29.03.18: - Fix staging for v2 api
- 13.03.18: - Support for wildcard cert with dns validation added. Switched to v2 api for ACME.
- 21.02.18: - Reduce shellcheck directives by renaming secondary variables
- 20.02.18: - Sanitize variables, increase log verbosity
- 01.02.18: - Big changes.
VALIDATION parameter added for choosing certbot validation methods, including dns through official plugins. HTTPVAL is deprecated. STAGING parameter added for testing. Backwards compatibility for the short term. Since tls-sni is disabled by letsencrypt, most users will have to change their settings and adopt the new parameters within the next 90 days. Reorganized the nginx default config, split ssl settings into new ssl.conf - 13.01.18: - Re-enable ipv6 due to update to fail2ban 0.10.1. Existing users can enable ipv6 by deleting
/config/fail2ban/action.d/iptables-common.local and restarting the container after updating the image - 11.01.18: - Halt the container if validation fails instead of a stop (so restart=always doesn't get users throttled with Let's Encrypt)
- 10.01.18: - Add option for http validation on port 80
- 05.01.18: - Rebase to alpine 3.7
- 04.11.17: - Add php7 soap module
- 31.10.17: - Add php7 exif and xmlreader modules
- 25.09.17: - Manage fail2ban via s6
- 24.09.17: - Add memcached service
- 01.09.17: -
--privileged is no longer required as long as --cap-add=NET_ADMIN is added, instructions modified accordingly, disabled fail2ban ipv6 actions due to requiring access to host kernel modules - 31.08.17: - Add php7-phar
- 14.07.17: - Enable modules dynamically in nginx.conf
- 06.07.17: - Add support for multiple domains (thanks @oznu)
- 22.06.17: - Add various nginx modules and enable all modules in the default nginx.conf
- 16.06.17: - Update deprecated certbot option for https validation, make e-mail entry optional, update readme
- 05.06.17: - Add php7-bz2
- 27.05.17: - Rebase to alpine 3.6.
- 03.05.17: - Fix log permissions.
- 18.04.17: - Add php7-sockets, update fail2ban filter and action defaults
- 27.02.17: - Add php7-dom, php7-iconv and php7-pdo_sqlite
- 21.02.17: - Add php7-xml
- 10.02.17: - Switch to alpine 3.5 base and php7, add php zlib module and all nginx modules
- 13.01.17: - Add php5-ctype and php5-openssl
- 04.01.17: - Add php5-mysqli and php5-pdo_mysql
- 22.11.16: - Add gd and mcrypt packages
- 21.11.16: - Add curl package
- 07.11.16: - Initial Release
\ No newline at end of file
+Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.
Versions¶
- 28.07.20: - Start transition to new name, SWAG.
- 17.06.20: - Reformat ssl.conf. Pull in pre-generated dhparams.pem from DO Spaces. Deprecate
DHLEVELparam. - 01.06.20: - Rebasing to alpine 3.12, change ldap login address to
/ldaploginto avoid clashes (existing users need to manually update). - 31.05.20: - Tweak Authelia confs (existing users can delete
authelia-server.confandauthelia-location.conf, and restart to update). - 23.05.20: - Add support for Authelia.
- 15.05.20: - Remove
php7-pecl-imagickdue to upstream issues. Add support forGeoip2auto db retrieval. - 10.05.20: - Added support for fail2ban deny statements.
- 04.05.20: - Allow for optionally setting propagation time for dns plugins. Add repo version of
whoisto replace the built-in busybox version. Updatejail.localto change default fail2ban ban action to more widely supportediptables-allports. - 13.04.20: - Update cloudflare.ini with token info.
- 11.03.20: - Add php7-sodium.
- 06.03.20: - Implement cert renewal attempt during container start (only if the cert is already expired or will expire within the next 24 hours, otherwise it will be attempted at 2:08am).
- 05.03.20: - Use port and proto upstream variables for ldap and default sample confs.
- 24.02.20: - Remove world/group read permissions in dns-conf.
- 23.02.20: - Add aliyun dns validation plugin.
- 28.01.20: - Deprecate tls-sni validation method, remove from docs.
- 27.01.20: - Add support for cpanel dns validation.
- 10.01.20: - Add support for domeneshop dns validation.
- 07.01.20: - Update ciphers from Mozilla ssl-config recommendations.
- 01.01.20: - Add support for gandi dns validation.
- 31.12.19: - GeoIP2 databases now require personal license keys to download. Auto download is disabled and log message is added.
- 19.12.19: - Rebasing to alpine 3.11.
- 19.12.19: - Increase large_client_header_buffers in nginx.conf to prevent 414 errors.
- 18.12.19: - Add php7-imap and php7-pecl-apcu.
- 11.12.19: - Fix Google Cloud DNS to use .json file for authentication.
- 20.11.19: - Fix cryptography version mismatch due to pip issue.
- 17.11.19: - Add php7-pdo_odbc.
- 17.11.19: - Add transip dns validation plugin.
- 27.10.19: - Turn off lua resty core to get rid of error message in the log (existing users will have to delete
/config/nginx/nginx.confand restart the container). - 26.10.19: - Add new package for stream-geoip2, remove geoip2 module patch.
- 24.10.19: - Add php7-pecl-imagick.
- 23.10.19: - Update Host header in
proxy.confto fix CSRF issues. - 12.10.19: - Add linode dns validation plugin.
- 23.09.19: - Move GeoIP2 db to /config to make it persistent.
- 14.08.19: - Add inwx dns validation plugin.
- 06.08.19: - Add php7-ftp.
- 04.08.19: - Add php7-bcmath, php7-pear, php7-xmlrpc.
- 02.08.19: - Add php7-ldap, remove geoip v1(deprecated).
- 01.08.19: - Mark https redirect block as default_server (effective only for new installs).
- 31.07.19: - Create GeoIP2 databse (libmaxminddb) during container start if it doesn't exist.
- 30.07.19: - Support main domain via duckdns validation.
- 29.07.19: - Enable http to https redirect by default (effective only for new installs).
- 01.07.19: - Patch geoip2 module until upstream is fixed.
- 30.06.19: - Add geoip2 module.
- 28.06.19: - Rebasing to alpine 3.10.
- 19.06.19: - Set resolver to docker dns in ssl.conf.
- 29.05.19: - Compensate for changes to the reverse-proxy-confs repo.
- 26.05.19: - Remove botocore/urllib patch.
- 08.05.19: - Remove default.conf when nginx is upgraded in downstream image.
- 30.04.19: - Add php-redis.
- 12.04.19: - Rebase aarch64 image to 3.9.
- 25.03.19: - Rebase aarch64 image back to 3.8 due to python issues (specifically with fail2ban), switch packages to python 3 on amd64 and armhf, clean up pip/python cache to shrink image size.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 10.03.19: - Add TLSv1.3 to ssl.conf.
- 02.03.19: - Add php intl and posix modules.
- 27.02.19: - Add gnupg package.
- 22.02.19: - Rebase to alpine 3.9.
- 03.02.19: - Removed memcached due to seccomp errors. Let us know if you need to re-enable memcached.
- 28.01.19: - Add pipeline logic and multi arch.
- 21.01.19: - Remove client_body_max from proxy.conf (existing users need to manually update).
- 09.01.19: - Remove tls v1 and v1.1 from default ssl.conf, update ciphers (existing users need to manually update).
- 30.12.18: - Fix bundle key generation.
- 19.12.18: - Add ipv6 and http/2 support to default site config.
- 08.12.18: - Had to remove cert renewal during container start due to certbot's new undocumented
featureof up to 8 minute random delay. - 03.12.18: - Fix silly bug resetting the duckdns token.
- 02.12.18: - Add dns validation support for ovh.
- 20.11.18: - Externalize reverse proxy confs to separate github repo
linuxserver/reverse-proxy-confs, update baseimage packages during build - 19.11.18: - Add php opcache package.
- 12.11.18: - Add support for duckdns wildcard certs via dns validation
- 31.10.18: - Add various preset proxy confs and fix others (thanks @nemchik and @hijxf)
- 02.10.18: - Fix fail2ban instructions and logrotate conf
- 11.09.18: - Add various preset proxy confs and fix others (thanks @nemchik and @LeoVerto)
- 04.09.18: - Linting fixes.
- 30.08.18: - Add support for ldap auth, add proxy confs for bazarr, couchpotato, headphones, lidarr and plex subfolder (thanks @nemchik and @jedahan)
- 21.08.18: - Rebase to alpine 3.8, add info on search engine de-listing
- 08.08.18: - Add subdomain proxy conf for plex, update emby proxy confs
- 25.07.18: - Add subdomain proxy conf for syncthing
- 23.07.18: - Remove backwards compatibility and set default validation method to http. Update portainer proxy config to fix websockets. Add unifi proxy conf.
- 31.05.18: - Update ssl.conf and proxy.conf for tighter security (thanks @nemchik)
- 30.05.18: - Add reverse proxy configs for jackett, monitorr, nzbget, nzbletsencrypt, organizr, portainer and transmission (thanks @nemchik)
- 18.05.18: - Add more info on certs and unraid reverse proxy config
- 11.05.18: - Add php pgsql support
- 24.04.18: - Auto generate a private key + fullchain bundle pem that is needed by certain apps
- 20.04.18: - Add standardized optional reverse proxy conf files
- 19.04.18: - Bind memcached to localhost only, add php7-sqlite3
- 08.04.18: - Fix renewal hooks
- 29.03.18: - Create pfx cert after renewal for dns validation (previous version only created it for http and tls, an oversight)
- 29.03.18: - Fix staging for v2 api
- 13.03.18: - Support for wildcard cert with dns validation added. Switched to v2 api for ACME.
- 21.02.18: - Reduce shellcheck directives by renaming secondary variables
- 20.02.18: - Sanitize variables, increase log verbosity
- 01.02.18: - Big changes.
VALIDATIONparameter added for choosing certbot validation methods, including dns through official plugins.HTTPVALis deprecated.STAGINGparameter added for testing. Backwards compatibility for the short term. Since tls-sni is disabled by letsencrypt, most users will have to change their settings and adopt the new parameters within the next 90 days. Reorganized the nginx default config, split ssl settings into new ssl.conf - 13.01.18: - Re-enable ipv6 due to update to fail2ban 0.10.1. Existing users can enable ipv6 by deleting
/config/fail2ban/action.d/iptables-common.localand restarting the container after updating the image - 11.01.18: - Halt the container if validation fails instead of a stop (so restart=always doesn't get users throttled with Let's Encrypt)
- 10.01.18: - Add option for http validation on port 80
- 05.01.18: - Rebase to alpine 3.7
- 04.11.17: - Add php7 soap module
- 31.10.17: - Add php7 exif and xmlreader modules
- 25.09.17: - Manage fail2ban via s6
- 24.09.17: - Add memcached service
- 01.09.17: -
--privilegedis no longer required as long as--cap-add=NET_ADMINis added, instructions modified accordingly, disabled fail2ban ipv6 actions due to requiring access to host kernel modules - 31.08.17: - Add php7-phar
- 14.07.17: - Enable modules dynamically in nginx.conf
- 06.07.17: - Add support for multiple domains (thanks @oznu)
- 22.06.17: - Add various nginx modules and enable all modules in the default nginx.conf
- 16.06.17: - Update deprecated certbot option for https validation, make e-mail entry optional, update readme
- 05.06.17: - Add php7-bz2
- 27.05.17: - Rebase to alpine 3.6.
- 03.05.17: - Fix log permissions.
- 18.04.17: - Add php7-sockets, update fail2ban filter and action defaults
- 27.02.17: - Add php7-dom, php7-iconv and php7-pdo_sqlite
- 21.02.17: - Add php7-xml
- 10.02.17: - Switch to alpine 3.5 base and php7, add php zlib module and all nginx modules
- 13.01.17: - Add php5-ctype and php5-openssl
- 04.01.17: - Add php5-mysqli and php5-pdo_mysql
- 22.11.16: - Add gd and mcrypt packages
- 21.11.16: - Add curl package
- 07.11.16: - Initial Release
linuxserver/libreoffice¶
LibreOffice is a free and powerful office suite, and a successor to OpenOffice.org (commonly known as OpenOffice). Its clean interface and feature-rich tools help you unleash your creativity and enhance your productivity.
Supported Architectures¶
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/libreoffice:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
The application can be accessed at:
- http://yourhost:3000/
- https://yourhost:3001/
Options in all KasmVNC based GUI containers¶
This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.
Optional environment variables¶
| Variable | Description |
|---|---|
| CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default 3000. |
| CUSTOM_HTTPS_PORT | Internal port the container listens on for https if it needs to be swapped from the default 3001. |
| CUSTOM_USER | HTTP Basic auth username, abc is default. |
| PASSWORD | HTTP Basic auth password, abc is default. If unset there will be no auth |
| SUBFOLDER | Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/ |
| TITLE | The page title displayed on the web browser, default "KasmVNC Client". |
| FM_HOME | This is the home directory (landing) for the file manager, default "/config". |
| START_DOCKER | If set to false a container with privilege will not automatically start the DinD Docker setup. |
| DRINODE | If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE /dev/dri/renderD128 |
Optional run configurations¶
| Variable | Description |
|---|---|
--privileged | Will start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE -v /home/user/docker-data:/var/lib/docker. |
-v /var/run/docker.sock:/var/run/docker.sock | Mount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. |
--device /dev/dri:/dev/dri | Mount a GPU into the container, this can be used in conjunction with the DRINODE environment variable to leverage a host video card for GPU accelerated appplications. Only Open Source drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau) |
Lossless mode¶
This container is capable of delivering a true lossless image at a high framerate to your web browser by changing the Stream Quality preset to "Lossless", more information here. In order to use this mode from a non localhost endpoint the HTTPS port on 3001 needs to be used. If using a reverse proxy to port 3000 specific headers will need to be set as outlined here.
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)¶
---
+ libreoffice - LinuxServer.io linuxserver/libreoffice¶
LibreOffice is a free and powerful office suite, and a successor to OpenOffice.org (commonly known as OpenOffice). Its clean interface and feature-rich tools help you unleash your creativity and enhance your productivity.
Supported Architectures¶
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/libreoffice:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
The application can be accessed at:
- http://yourhost:3000/
- https://yourhost:3001/
Options in all KasmVNC based GUI containers¶
This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.
Optional environment variables¶
Variable Description CUSTOM_PORT Internal port the container listens on for http if it needs to be swapped from the default 3000. CUSTOM_HTTPS_PORT Internal port the container listens on for https if it needs to be swapped from the default 3001. CUSTOM_USER HTTP Basic auth username, abc is default. PASSWORD HTTP Basic auth password, abc is default. If unset there will be no auth SUBFOLDER Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/ TITLE The page title displayed on the web browser, default "KasmVNC Client". FM_HOME This is the home directory (landing) for the file manager, default "/config". START_DOCKER If set to false a container with privilege will not automatically start the DinD Docker setup. DRINODE If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE /dev/dri/renderD128
Optional run configurations¶
Variable Description --privilegedWill start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE -v /home/user/docker-data:/var/lib/docker. -v /var/run/docker.sock:/var/run/docker.sockMount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. --device /dev/dri:/dev/driMount a GPU into the container, this can be used in conjunction with the DRINODE environment variable to leverage a host video card for GPU accelerated appplications. Only Open Source drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau)
Lossless mode¶
This container is capable of delivering a true lossless image at a high framerate to your web browser by changing the Stream Quality preset to "Lossless", more information here. In order to use this mode from a non localhost endpoint the HTTPS port on 3001 needs to be used. If using a reverse proxy to port 3000 specific headers will need to be set as outlined here.
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)¶
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 3000LibreOffice desktop gui. 3001LibreOffice desktop gui HTTPS.
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configUsers home directory in the container, stores program settings and documents
Miscellaneous Options¶
Parameter Function --security-opt seccomp=unconfinedFor Docker Engine only, many modern gui apps need this to function on older hosts as syscalls are unknown to Docker.
Environment variables from files (Docker secrets)¶
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
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:
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 libreoffice /bin/bash- To monitor the logs of the container in realtime:
docker logs -f libreoffice- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' libreoffice- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/libreoffice:latest
Versions¶
- 13.05.23: - Rebase to Alpine 3.18.
- 18.03.23: - Rebase to KasmVNC base image.
- 21.10.22: - Rebase to Alpine 3.16, migrate to s6v3.
- 23.12.21: - Rebase to Alpine 3.15.
- 26.09.21: - Rebase to Alpine 3.14.
- 05.04.21: - Initial release.
\ No newline at end of file
+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 libreoffice /bin/bash- To monitor the logs of the container in realtime:
docker logs -f libreoffice- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' libreoffice- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/libreoffice:latest
Versions¶
- 13.05.23: - Rebase to Alpine 3.18.
- 18.03.23: - Rebase to KasmVNC base image.
- 21.10.22: - Rebase to Alpine 3.16, migrate to s6v3.
- 23.12.21: - Rebase to Alpine 3.15.
- 26.09.21: - Rebase to Alpine 3.14.
- 05.04.21: - Initial release.
DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. PLEASE USE AIRSONIC linuxserver/airsonic
linuxserver/libresonic¶
Libresonic is a free, web-based media streamer, providing ubiqutious access to your music. Use it to share your music with friends, or to listen to your own music while at work. You can stream to multiple players simultaneously, for instance to one player in your kitchen and another in your living room.
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 linuxserver/libresonic 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 | amd64-latest |
| arm64 | arm64v8-latest |
| armhf | arm32v7-latest |
Usage¶
Here are some example snippets to help you get started creating a container from this image.
docker¶
docker create \
+ libresonic - LinuxServer.io DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. PLEASE USE AIRSONIC linuxserver/airsonic
linuxserver/libresonic¶
Libresonic is a free, web-based media streamer, providing ubiqutious access to your music. Use it to share your music with friends, or to listen to your own music while at work. You can stream to multiple players simultaneously, for instance to one player in your kitchen and another in your living room.
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 linuxserver/libresonic 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 amd64-latest arm64 arm64v8-latest armhf arm32v7-latest
Usage¶
Here are some example snippets to help you get started creating a container from this image.
docker¶
docker create \
--name=libresonic \
-e PUID=1000 \
-e PGID=1000 \
@@ -35,4 +35,4 @@
restart: unless-stopped
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 4040WebUI
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Europe/LondonSpecify a timezone to use EG Europe/London. CONTEXT_PATH=<URL_BASE>For setting url-base in reverse proxy setups.
Volume Mappings (-v)¶
Volume Function /configConfiguration file location. /musicLocation of music. /playlistsLocation for playlists to be saved to. /podcastsLocation of podcasts. /mediaLocation of other media.
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:
Application Setup¶
Access WebUI at <your-ip>:4040.
Default user/pass is admin/admin
Support Info¶
- Shell access whilst the container is running:
docker exec -it libresonic /bin/bash- To monitor the logs of the container in realtime:
docker logs -f libresonic- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' libresonic- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/libresonic
Versions¶
- 24.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 15.01.19: - Pull war from github, adding pipeline multi arch builds.
- 05.01.19: - Linting fixes.
- 27.08.18: - Rebase to ubuntu bionic.
- 12.12.17: - Rebase to alpine 3.7.
- 11.07.17: - Rebase to alpine 3.6.
- 12.05.17: - Add annotation timeout (primarily for armhf and lower powered hosts).
- 08.02.17: - Rebase to alpine 3.5.
- 04.12.16: - Update jetty runner version.
- 29.11.16: - Switch to building from release tags following v6.1 stable release.
- 17.11.16: - Initial Release.
\ No newline at end of file
+Application Setup¶
Access WebUI at <your-ip>:4040.
Default user/pass is admin/admin
Support Info¶
- Shell access whilst the container is running:
docker exec -it libresonic /bin/bash- To monitor the logs of the container in realtime:
docker logs -f libresonic- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' libresonic- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/libresonic
Versions¶
- 24.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 15.01.19: - Pull war from github, adding pipeline multi arch builds.
- 05.01.19: - Linting fixes.
- 27.08.18: - Rebase to ubuntu bionic.
- 12.12.17: - Rebase to alpine 3.7.
- 11.07.17: - Rebase to alpine 3.6.
- 12.05.17: - Add annotation timeout (primarily for armhf and lower powered hosts).
- 08.02.17: - Rebase to alpine 3.5.
- 04.12.16: - Update jetty runner version.
- 29.11.16: - Switch to building from release tags following v6.1 stable release.
- 17.11.16: - Initial Release.
linuxserver/librespeed¶
Librespeed is a very lightweight Speedtest implemented in Javascript, using XMLHttpRequest and Web Workers.
No Flash, No Java, No Websocket, No Bullshit.
Supported Architectures¶
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/librespeed:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
Access the speedtest webui at http://SERVERIP. The results database can be accessed at http://SERVERIP/results/stats.php with the password set.
The default template used is based on example-singleServer-full.html. However, all templates are provided for reference at /config/www/. Feel free to customize /config/www/index.html as you like. Delete the file and restart to go back to the image default.
You can optionally place customized speedtest.js and speedtest_worker.js files under /config/www and they will supersede the defaults after a container start. Keep in mind that once you do so, they will no longer be updated. You can delete them and recreate the container to go back to the image defaults.
If you are setting up a mysql or postgresql database, you first need to import the tables into your database as described at the following link
https://github.com/librespeed/speedtest/blob/master/doc.md#creating-the-database
To enable a custom results page set the environment variable CUSTOM_RESULTS=true and start (or restart) the container at least once for /config/www/results/index.php to be created and modify this file to your liking.
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)¶
---
+ librespeed - LinuxServer.io linuxserver/librespeed¶
Librespeed is a very lightweight Speedtest implemented in Javascript, using XMLHttpRequest and Web Workers.
No Flash, No Java, No Websocket, No Bullshit.
Supported Architectures¶
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/librespeed:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
Access the speedtest webui at http://SERVERIP. The results database can be accessed at http://SERVERIP/results/stats.php with the password set.
The default template used is based on example-singleServer-full.html. However, all templates are provided for reference at /config/www/. Feel free to customize /config/www/index.html as you like. Delete the file and restart to go back to the image default.
You can optionally place customized speedtest.js and speedtest_worker.js files under /config/www and they will supersede the defaults after a container start. Keep in mind that once you do so, they will no longer be updated. You can delete them and recreate the container to go back to the image defaults.
If you are setting up a mysql or postgresql database, you first need to import the tables into your database as described at the following link
https://github.com/librespeed/speedtest/blob/master/doc.md#creating-the-database
To enable a custom results page set the environment variable CUSTOM_RESULTS=true and start (or restart) the container at least once for /config/www/results/index.php to be created and modify this file to your liking.
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)¶
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 80web gui
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. PASSWORD=PASSWORDSet the password for the results database. CUSTOM_RESULTS=false(optional) set to true to enable custom results page in /config/www/results/index.php. DB_TYPE=sqliteDefaults to sqlite, can also be set to mysql or postgresql. DB_NAME=DB_NAMEDatabase name. Required for mysql and pgsql. DB_HOSTNAME=DB_HOSTNAMEDatabase address. Required for mysql and pgsql. DB_USERNAME=DB_USERNAMEDatabase username. Required for mysql and pgsql. DB_PASSWORD=DB_PASSWORDDatabase password. Required for mysql and pgsql. DB_PORT=DB_PORTDatabase port. Required for mysql. IPINFO_APIKEY=ACCESS_TOKENAccess token from ipinfo.io. Required for detailed IP information.
Volume Mappings (-v)¶
Volume Function /configContains all relevant configuration files.
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:
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:
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 librespeed /bin/bash- To monitor the logs of the container in realtime:
docker logs -f librespeed- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' librespeed- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/librespeed:latest
Versions¶
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 14.05.23: - Added support for ipinfo.io
- 20.01.23: - Rebase to alpine 3.17 with php8.1.
- 20.08.22: - Rebasing to alpine 3.15 with php8. Restructure nginx configs (see changes announcement).
- 01.03.21: - Fix up database settings. Make sure
index.html is recreated. - 28.02.21: - Added php7-ctype.
- 23.01.21: - Rebasing to alpine 3.13.
- 01.06.20: - Rebasing to alpine 3.12.
- 29.04.20: - Add donation links for LibreSpeed to Github sponsor button and container log.
- 09.01.20: - Initial Release.
\ No newline at end of file
+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 librespeed /bin/bash- To monitor the logs of the container in realtime:
docker logs -f librespeed- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' librespeed- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/librespeed:latest
Versions¶
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 14.05.23: - Added support for ipinfo.io
- 20.01.23: - Rebase to alpine 3.17 with php8.1.
- 20.08.22: - Rebasing to alpine 3.15 with php8. Restructure nginx configs (see changes announcement).
- 01.03.21: - Fix up database settings. Make sure
index.htmlis recreated. - 28.02.21: - Added php7-ctype.
- 23.01.21: - Rebasing to alpine 3.13.
- 01.06.20: - Rebasing to alpine 3.12.
- 29.04.20: - Add donation links for LibreSpeed to Github sponsor button and container log.
- 09.01.20: - Initial Release.
linuxserver/lidarr¶
Lidarr is a music collection manager for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new tracks from your favorite artists and will grab, sort and rename them. It can also be configured to automatically upgrade the quality of files already downloaded when a better quality format becomes available.
Supported Architectures¶
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/lidarr:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
| Tag | Available | Description |
|---|---|---|
| latest | ✅ | Stable Lidarr releases. |
| develop | ✅ | Develop Lidarr Releases. |
| nightly | ✅ | Nightly Lidarr Releases. |
| ## Application Setup |
Access the webui at <your-ip>:8686, for more information check out Lidarr.
Special Note: Following our current folder structure will result in an inability to hardlink from your downloads to your Music folder because they are on seperate volumes. To support hardlinking, simply ensure that the Music and downloads data are on a single volume. For example, if you have /mnt/storage/Music and /mnt/storage/downloads/completed/Music, you would want something like /mnt/storage:/media for your volume. Then you can hardlink from /media/downloads/completed to /media/Music.
Another item to keep in mind, is that within lidarr itself, you should then map your download client folder to your lidarr folder: Settings -> Download Client -> advanced -> remote path mappings. I input the host of my download client (matches the download client defined) remote path is /downloads/Music (relative to the internal container path) and local path is /media/downloads/completed/Music, assuming you have folders to seperate your downloaded data types.
Media folders¶
We have set /music and /downloads as optional paths, this is because it is the easiest way to get started. While easy to use, it has some drawbacks. Mainly losing the ability to hardlink (TL;DR a way for a file to exist in multiple places on the same file system while only consuming one file worth of space), or atomic move (TL;DR instant file moves, rather than copy+delete) files while processing content.
Use the optional paths if you dont understand, or dont want hardlinks/atomic moves.
The folks over at servarr.com wrote a good write-up on how to get started with this.
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)¶
---
+ lidarr - LinuxServer.io linuxserver/lidarr¶
Lidarr is a music collection manager for Usenet and BitTorrent users. It can monitor multiple RSS feeds for new tracks from your favorite artists and will grab, sort and rename them. It can also be configured to automatically upgrade the quality of files already downloaded when a better quality format becomes available.
Supported Architectures¶
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/lidarr:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
Tag Available Description latest ✅ Stable Lidarr releases. develop ✅ Develop Lidarr Releases. nightly ✅ Nightly Lidarr Releases. ## Application Setup
Access the webui at <your-ip>:8686, for more information check out Lidarr.
Special Note: Following our current folder structure will result in an inability to hardlink from your downloads to your Music folder because they are on seperate volumes. To support hardlinking, simply ensure that the Music and downloads data are on a single volume. For example, if you have /mnt/storage/Music and /mnt/storage/downloads/completed/Music, you would want something like /mnt/storage:/media for your volume. Then you can hardlink from /media/downloads/completed to /media/Music.
Another item to keep in mind, is that within lidarr itself, you should then map your download client folder to your lidarr folder: Settings -> Download Client -> advanced -> remote path mappings. I input the host of my download client (matches the download client defined) remote path is /downloads/Music (relative to the internal container path) and local path is /media/downloads/completed/Music, assuming you have folders to seperate your downloaded data types.
Media folders¶
We have set /music and /downloads as optional paths, this is because it is the easiest way to get started. While easy to use, it has some drawbacks. Mainly losing the ability to hardlink (TL;DR a way for a file to exist in multiple places on the same file system while only consuming one file worth of space), or atomic move (TL;DR instant file moves, rather than copy+delete) files while processing content.
Use the optional paths if you dont understand, or dont want hardlinks/atomic moves.
The folks over at servarr.com wrote a good write-up on how to get started with this.
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)¶
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 8686Application WebUI
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configConfiguration files for Lidarr. /musicMusic files (See note in Application setup). /downloadsPath to your download folder for music (See note in Application setup).
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:
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:
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 lidarr /bin/bash- To monitor the logs of the container in realtime:
docker logs -f lidarr- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lidarr- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/lidarr:latest
Versions¶
- 06.06.23: - Rebase master to Alpine 3.18, deprecate armhf as per https://www.linuxserver.io/armhf.
- 17.01.23: - Rebase master branch to Alpine 3.17, migrate to s6v3.
- 06.06.22: - Rebase master branch to Alpine 3.15.
- 06.05.22: - Rebase master branch to Focal.
- 06.05.22: - Rebase develop branch to Alpine.
- 04.02.22: - Rebase nightly branch to Alpine, deprecate nightly-alpine branch.
- 30.12.21: - Add nightly-alpine branch.
- 01.08.21: - Add libchromaprint-tools.
- 11.07.21: - Make the paths clearer to the user.
- 18.04.21: - Switch
latest tag to net core. - 25.01.21: - Publish
develop tag. - 20.01.21: - Deprecate
UMASK_SET in favor of UMASK in baseimage, see above for more information. - 18.04.20: - Removed /downloads and /music volumes from Dockerfiles.
- 05.04.20: - Move app to /app.
- 01.08.19: - Rebase to Linuxserver LTS mono version.
- 13.06.19: - Add env variable for setting umask.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 08.03.19: - Rebase to Bionic, use proposed endpoint for libchromaprint.
- 26.01.19: - Add pipeline logic and multi arch.
- 22.04.18: - Switch to beta builds.
- 17.03.18: - Add ENV XDG_CONFIG_HOME="/config/xdg" to Dockerfile for signalr fix.
- 27.02.18: - Use json to query for new version.
- 23.02.18: - Initial Release.
\ No newline at end of file
+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 lidarr /bin/bash- To monitor the logs of the container in realtime:
docker logs -f lidarr- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lidarr- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/lidarr:latest
Versions¶
- 06.06.23: - Rebase master to Alpine 3.18, deprecate armhf as per https://www.linuxserver.io/armhf.
- 17.01.23: - Rebase master branch to Alpine 3.17, migrate to s6v3.
- 06.06.22: - Rebase master branch to Alpine 3.15.
- 06.05.22: - Rebase master branch to Focal.
- 06.05.22: - Rebase develop branch to Alpine.
- 04.02.22: - Rebase nightly branch to Alpine, deprecate nightly-alpine branch.
- 30.12.21: - Add nightly-alpine branch.
- 01.08.21: - Add libchromaprint-tools.
- 11.07.21: - Make the paths clearer to the user.
- 18.04.21: - Switch
latesttag to net core. - 25.01.21: - Publish
developtag. - 20.01.21: - Deprecate
UMASK_SETin favor of UMASK in baseimage, see above for more information. - 18.04.20: - Removed /downloads and /music volumes from Dockerfiles.
- 05.04.20: - Move app to /app.
- 01.08.19: - Rebase to Linuxserver LTS mono version.
- 13.06.19: - Add env variable for setting umask.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 08.03.19: - Rebase to Bionic, use proposed endpoint for libchromaprint.
- 26.01.19: - Add pipeline logic and multi arch.
- 22.04.18: - Switch to beta builds.
- 17.03.18: - Add ENV XDG_CONFIG_HOME="/config/xdg" to Dockerfile for signalr fix.
- 27.02.18: - Use json to query for new version.
- 23.02.18: - Initial Release.
linuxserver/limnoria¶
Limnoria A robust, full-featured, and user/programmer-friendly Python IRC bot, with many existing plugins. Successor of the well-known Supybot.
Supported Architectures¶
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/limnoria:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
New Configuration¶
If you do not have an existing config you will need to start the container and then run the following wizard command:
docker exec -it -w /config -u abc limnoria limnoria-wizard
Existing Configuration¶
If you have an existing config, adjust the directory settings in your conf file as follows:
supybot.directories.backup: /config/backup
+ limnoria - LinuxServer.io linuxserver/limnoria¶
Limnoria A robust, full-featured, and user/programmer-friendly Python IRC bot, with many existing plugins. Successor of the well-known Supybot.
Supported Architectures¶
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/limnoria:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
New Configuration¶
If you do not have an existing config you will need to start the container and then run the following wizard command:
docker exec -it -w /config -u abc limnoria limnoria-wizard
Existing Configuration¶
If you have an existing config, adjust the directory settings in your conf file as follows:
supybot.directories.backup: /config/backup
supybot.directories.conf: /config/conf
supybot.directories.data: /config/data
supybot.directories.data.tmp: /config/data/tmp
@@ -32,4 +32,4 @@
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 8080Port for Limnoria's web interface.
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configWhere Limnoria config is stored.
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:
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:
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 limnoria /bin/bash- To monitor the logs of the container in realtime:
docker logs -f limnoria- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' limnoria- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/limnoria:latest
Versions¶
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 22.12.22: - Rebase to alpine 3.17.
- 19.09.22: - Rebase to alpine 3.15.
- 25.05.21: - Install plugin requirements on container init.
- 17.05.21: - Add linuxserver wheel index.
- 13.02.21: - Rebasing to alpine 3.13.
- 01.06.20: - Rebasing to alpine 3.12.
- 13.01.20: - Initial Release.
\ No newline at end of file
+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 limnoria /bin/bash- To monitor the logs of the container in realtime:
docker logs -f limnoria- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' limnoria- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/limnoria:latest
Versions¶
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 22.12.22: - Rebase to alpine 3.17.
- 19.09.22: - Rebase to alpine 3.15.
- 25.05.21: - Install plugin requirements on container init.
- 17.05.21: - Add linuxserver wheel index.
- 13.02.21: - Rebasing to alpine 3.13.
- 01.06.20: - Rebasing to alpine 3.12.
- 13.01.20: - Initial Release.
linuxserver/lollypop¶
Lollypop is a lightweight modern music player designed to work excellently on the GNOME desktop environment.
Supported Architectures¶
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/lollypop:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
The application can be accessed at:
- http://yourhost:3000/
- https://yourhost:3001/
Options in all KasmVNC based GUI containers¶
This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.
Optional environment variables¶
| Variable | Description |
|---|---|
| CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default 3000. |
| CUSTOM_HTTPS_PORT | Internal port the container listens on for https if it needs to be swapped from the default 3001. |
| CUSTOM_USER | HTTP Basic auth username, abc is default. |
| PASSWORD | HTTP Basic auth password, abc is default. If unset there will be no auth |
| SUBFOLDER | Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/ |
| TITLE | The page title displayed on the web browser, default "KasmVNC Client". |
| FM_HOME | This is the home directory (landing) for the file manager, default "/config". |
| START_DOCKER | If set to false a container with privilege will not automatically start the DinD Docker setup. |
| DRINODE | If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE /dev/dri/renderD128 |
Optional run configurations¶
| Variable | Description |
|---|---|
--privileged | Will start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE -v /home/user/docker-data:/var/lib/docker. |
-v /var/run/docker.sock:/var/run/docker.sock | Mount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. |
--device /dev/dri:/dev/dri | Mount a GPU into the container, this can be used in conjunction with the DRINODE environment variable to leverage a host video card for GPU accelerated appplications. Only Open Source drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau) |
Lossless mode¶
This container is capable of delivering a true lossless image at a high framerate to your web browser by changing the Stream Quality preset to "Lossless", more information here. In order to use this mode from a non localhost endpoint the HTTPS port on 3001 needs to be used. If using a reverse proxy to port 3000 specific headers will need to be set as outlined here.
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)¶
---
+ lollypop - LinuxServer.io linuxserver/lollypop¶
Lollypop is a lightweight modern music player designed to work excellently on the GNOME desktop environment.
Supported Architectures¶
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/lollypop:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
The application can be accessed at:
- http://yourhost:3000/
- https://yourhost:3001/
Options in all KasmVNC based GUI containers¶
This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.
Optional environment variables¶
Variable Description CUSTOM_PORT Internal port the container listens on for http if it needs to be swapped from the default 3000. CUSTOM_HTTPS_PORT Internal port the container listens on for https if it needs to be swapped from the default 3001. CUSTOM_USER HTTP Basic auth username, abc is default. PASSWORD HTTP Basic auth password, abc is default. If unset there will be no auth SUBFOLDER Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/ TITLE The page title displayed on the web browser, default "KasmVNC Client". FM_HOME This is the home directory (landing) for the file manager, default "/config". START_DOCKER If set to false a container with privilege will not automatically start the DinD Docker setup. DRINODE If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE /dev/dri/renderD128
Optional run configurations¶
Variable Description --privilegedWill start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE -v /home/user/docker-data:/var/lib/docker. -v /var/run/docker.sock:/var/run/docker.sockMount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. --device /dev/dri:/dev/driMount a GPU into the container, this can be used in conjunction with the DRINODE environment variable to leverage a host video card for GPU accelerated appplications. Only Open Source drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau)
Lossless mode¶
This container is capable of delivering a true lossless image at a high framerate to your web browser by changing the Stream Quality preset to "Lossless", more information here. In order to use this mode from a non localhost endpoint the HTTPS port on 3001 needs to be used. If using a reverse proxy to port 3000 specific headers will need to be set as outlined here.
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)¶
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 3000Lollypop desktop gui. 3001Lollypop desktop gui HTTPS.
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configUsers home directory in the container, stores settings and downloaded metadata for music.
Miscellaneous Options¶
Parameter Function --security-opt seccomp=unconfinedFor Docker Engine only, many modern gui apps need this to function on older hosts as syscalls are unknown to Docker.
Environment variables from files (Docker secrets)¶
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
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:
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 lollypop /bin/bash- To monitor the logs of the container in realtime:
docker logs -f lollypop- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lollypop- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/lollypop:latest
Versions¶
- 21.04.23: - Initial release.
\ No newline at end of file
+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 lollypop /bin/bash- To monitor the logs of the container in realtime:
docker logs -f lollypop- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lollypop- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/lollypop:latest
Versions¶
- 21.04.23: - Initial release.
linuxserver/lychee¶
Lychee is a free photo-management tool, which runs on your server or web-space. Installing is a matter of seconds. Upload, manage and share photos like from a native application. Lychee comes with everything you need and all your photos are stored securely."
UPGRADE WARNING¶
Please note that the v4 upgrade process resets ALL password-protected albums. Any albums that were made public with a password will need to be re-secured.
Supported Architectures¶
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/lychee:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
This image will not work with a prefilled /pictures mount, lychee wants total control over this folder
Setup mysql/mariadb and account via the webui, accessible at http://SERVERIP:PORT More info at lychee.
Customization¶
In certain scenarios, you might need to change the default settings of Lychee. For instance, if you encounter limitations when uploading large files, you can increase this limit.
Increasing Upload Limit¶
The upload limit is defined in the user.ini file located in the config directory (/config). You can increase this limit by modifying the following values:
post_max_size = 500M
+ lychee - LinuxServer.io linuxserver/lychee¶
Lychee is a free photo-management tool, which runs on your server or web-space. Installing is a matter of seconds. Upload, manage and share photos like from a native application. Lychee comes with everything you need and all your photos are stored securely."
UPGRADE WARNING¶
Please note that the v4 upgrade process resets ALL password-protected albums. Any albums that were made public with a password will need to be re-secured.
Supported Architectures¶
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/lychee:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
This image will not work with a prefilled /pictures mount, lychee wants total control over this folder
Setup mysql/mariadb and account via the webui, accessible at http://SERVERIP:PORT More info at lychee.
Customization¶
In certain scenarios, you might need to change the default settings of Lychee. For instance, if you encounter limitations when uploading large files, you can increase this limit.
Increasing Upload Limit¶
The upload limit is defined in the user.ini file located in the config directory (/config). You can increase this limit by modifying the following values:
After making these changes, you'll need to restart the Docker container for the changes to take effect. Here's how to do it:
Please note that these changes might have implications on your server's performance, depending on its available resources. Thus, it's recommended to modify these settings with caution.
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)¶
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 80http gui
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. DB_CONNECTION=mysqlfor specifying the database type DB_HOST=mariadbfor specifying the database host DB_PORT=3306for specifying the database port DB_USERNAME=lycheefor specifying the database user DB_PASSWORD=dbpasswordfor specifying the database password DB_DATABASE=lycheefor specifying the database to be used
Volume Mappings (-v)¶
Volume Function /configContains all relevant configuration files. /picturesWhere lychee will store uploaded data.
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:
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:
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 lychee /bin/bash- To monitor the logs of the container in realtime:
docker logs -f lychee- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lychee- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/lychee:latest
Versions¶
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 13.04.23: - Move ssl.conf include to default.conf.
- 11.01.23: - Rebasing to alpine 3.17 with php8.1. Restructure nginx configs (see changes announcement). Switch to git clone as builds fail with the release artifact.
- 13.05.21: - Make readme clearer.
- 18.04.21: - Add php-intl for v4.3.
- 31.01.21: - Add jpegoptim.
- 15.01.21: - Rebase to alpine 3.13, add php7-ctype.
- 10.07.20: - Upgrade to Lychee v4 and rebased to alpine 3.12.
- 19.12.19: - Rebasing to alpine 3.11.
- 23.10.19: - Increase fastcgi timeouts (existing users need to manually update).
- 19.09.19: - Update project website url.
- 28.06.19: - Rebasing to alpine 3.10.
- 05.05.19: - Rebase to alpine 3.9, use new armv7 image format.
- 21.01.18: - Added ffmpeg for video thumbnail creation, switched to installing zip release instead of source tarball, created small thumbnails folder, switched to dynamic readme.
- 14.01.19: - Adding pipeline logic and multi arch..
- 04.09.18: - Rebase to alpine 3.8, switch to LycheeOrg repository.
- 08.01.18: - Rebase to alpine 3.7.
- 25.05.17: - Rebase to alpine 3.6.
- 03.05.17: - Use repo pinning to better solve dependencies, use repo version of php7-imagick.
- 12.02.17: - Initial Release.
\ No newline at end of file
+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 lychee /bin/bash- To monitor the logs of the container in realtime:
docker logs -f lychee- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lychee- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/lychee:latest
Versions¶
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 13.04.23: - Move ssl.conf include to default.conf.
- 11.01.23: - Rebasing to alpine 3.17 with php8.1. Restructure nginx configs (see changes announcement). Switch to git clone as builds fail with the release artifact.
- 13.05.21: - Make readme clearer.
- 18.04.21: - Add php-intl for v4.3.
- 31.01.21: - Add jpegoptim.
- 15.01.21: - Rebase to alpine 3.13, add php7-ctype.
- 10.07.20: - Upgrade to Lychee v4 and rebased to alpine 3.12.
- 19.12.19: - Rebasing to alpine 3.11.
- 23.10.19: - Increase fastcgi timeouts (existing users need to manually update).
- 19.09.19: - Update project website url.
- 28.06.19: - Rebasing to alpine 3.10.
- 05.05.19: - Rebase to alpine 3.9, use new armv7 image format.
- 21.01.18: - Added ffmpeg for video thumbnail creation, switched to installing zip release instead of source tarball, created small thumbnails folder, switched to dynamic readme.
- 14.01.19: - Adding pipeline logic and multi arch..
- 04.09.18: - Rebase to alpine 3.8, switch to LycheeOrg repository.
- 08.01.18: - Rebase to alpine 3.7.
- 25.05.17: - Rebase to alpine 3.6.
- 03.05.17: - Use repo pinning to better solve dependencies, use repo version of php7-imagick.
- 12.02.17: - Initial Release.
linuxserver/mariadb¶
Mariadb is one of the most popular database servers. Made by the original developers of MySQL.
Supported Architectures¶
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/mariadb:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
If you didn't set a password during installation, (see logs for warning) use mariadb-admin -u root -p<PASSWORD> to set one at the docker prompt...
NOTE changing the MYSQL_ROOT_PASSWORD variable after the container has set up the initial databases has no effect, use the mysqladmin tool to change your mariadb password.
NOTE if you want to use (MYSQL_DATABASE MYSQL_USER MYSQL_PASSWORD) all three of these variables need to be set you cannot pick and choose.
Unraid users, it is advisable to edit the template/webui after setup and remove reference to this variable.
Find custom.cnf in /config for config changes (restart container for them to take effect) , the databases in /config/databases and the log in /config/log/myqsl
Loading passwords and users from files¶
The MYSQL_ROOT_PASSWORD MYSQL_DATABASE MYSQL_USER MYSQL_PASSWORD REMOTE_SQL env values can be set in a file:
/config/env
+ mariadb - LinuxServer.io linuxserver/mariadb¶
Mariadb is one of the most popular database servers. Made by the original developers of MySQL.
Supported Architectures¶
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/mariadb:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
If you didn't set a password during installation, (see logs for warning) use mariadb-admin -u root -p<PASSWORD> to set one at the docker prompt...
NOTE changing the MYSQL_ROOT_PASSWORD variable after the container has set up the initial databases has no effect, use the mysqladmin tool to change your mariadb password.
NOTE if you want to use (MYSQL_DATABASE MYSQL_USER MYSQL_PASSWORD) all three of these variables need to be set you cannot pick and choose.
Unraid users, it is advisable to edit the template/webui after setup and remove reference to this variable.
Find custom.cnf in /config for config changes (restart container for them to take effect) , the databases in /config/databases and the log in /config/log/myqsl
Loading passwords and users from files¶
The MYSQL_ROOT_PASSWORD MYSQL_DATABASE MYSQL_USER MYSQL_PASSWORD REMOTE_SQL env values can be set in a file:
Using the following format:
MYSQL_ROOT_PASSWORD="ROOT_ACCESS_PASSWORD"
MYSQL_DATABASE="USER_DB_NAME"
MYSQL_USER="MYSQL_USER"
@@ -47,4 +47,4 @@
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 3306Mariadb listens on this port.
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. MYSQL_ROOT_PASSWORD=ROOT_ACCESS_PASSWORDSet this to root password for installation (minimum 4 characters & non-alphanumeric passwords must be properly escaped). MYSQL_DATABASE=USER_DB_NAMESpecify the name of a database to be created on image startup. MYSQL_USER=MYSQL_USERThis user will have superuser access to the database specified by MYSQL_DATABASE (do not use root here). MYSQL_PASSWORD=DATABASE_PASSWORDSet this to the password you want to use for you MYSQL_USER (minimum 4 characters & non-alphanumeric passwords must be properly escaped). REMOTE_SQL=http://URL1/your.sql,https://URL2/your.sqlSet this to ingest sql files from an http/https endpoint (comma seperated array).
Volume Mappings (-v)¶
Volume Function /configContains the db itself and all assorted 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:
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:
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 mariadb /bin/bash- To monitor the logs of the container in realtime:
docker logs -f mariadb- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' mariadb- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/mariadb:latest
Versions¶
- 09.06.23: - Update lc_messages path in shipped custom.cnf to match upstream.
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 04.02.23: - Minor updates to defaults in custom.cnf.
- 31.01.23: - Rebase to 3.17.
- 09.12.22: - Add upgrade check warning.
- 11.10.22: - Rebase master to Alpine 3.16, migrate to s6v3, remove password escape logic which caused problems for a small subset of users.
- 06.07.21: - Rebase master to alpine.
- 03.07.21: - Rebase to 3.14.
- 08.02.21: - Fix new installs.
- 08.02.21: - Rebase to alpine. Add mariadb-backup.
- 08.02.21: - Release alpine tag. The alpine release will replace the latest tag in the near future.
- 27.10.19: - Bump to 10.4, ability use custom sql on initial init ,defining root passwords via file.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 07.03.19: - Add ability to setup a database and default user on first spinup.
- 26.01.19: - Add pipeline logic and multi arch.
- 10.09.18: - Rebase to ubuntu bionic and use 10.3 mariadb repository.
- 09.12.17: - Fix continuation lines.
- 12.09.17: - Gracefully shut down mariadb.
- 27.10.16: - Implement linting suggestions on database init script.
- 11.10.16: - Rebase to ubuntu xenial, add version labelling.
- 09.03.16: - Update to mariadb 10.1. Change to use custom.cnf over my.cnf in /config. Restructured init files to change config options on startup, rather than in the dockerfile.
- 26.01.16: - Change user of mysqld_safe script to abc, better unclean shutdown handling on restart.
- 23.12.15: - Remove autoupdating, between some version updates the container breaks.
- 12.08.15: - Initial Release.
\ No newline at end of file
+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 mariadb /bin/bash- To monitor the logs of the container in realtime:
docker logs -f mariadb- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' mariadb- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/mariadb:latest
Versions¶
- 09.06.23: - Update lc_messages path in shipped custom.cnf to match upstream.
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 04.02.23: - Minor updates to defaults in custom.cnf.
- 31.01.23: - Rebase to 3.17.
- 09.12.22: - Add upgrade check warning.
- 11.10.22: - Rebase master to Alpine 3.16, migrate to s6v3, remove password escape logic which caused problems for a small subset of users.
- 06.07.21: - Rebase master to alpine.
- 03.07.21: - Rebase to 3.14.
- 08.02.21: - Fix new installs.
- 08.02.21: - Rebase to alpine. Add mariadb-backup.
- 08.02.21: - Release alpine tag. The alpine release will replace the latest tag in the near future.
- 27.10.19: - Bump to 10.4, ability use custom sql on initial init ,defining root passwords via file.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 07.03.19: - Add ability to setup a database and default user on first spinup.
- 26.01.19: - Add pipeline logic and multi arch.
- 10.09.18: - Rebase to ubuntu bionic and use 10.3 mariadb repository.
- 09.12.17: - Fix continuation lines.
- 12.09.17: - Gracefully shut down mariadb.
- 27.10.16: - Implement linting suggestions on database init script.
- 11.10.16: - Rebase to ubuntu xenial, add version labelling.
- 09.03.16: - Update to mariadb 10.1. Change to use custom.cnf over my.cnf in /config. Restructured init files to change config options on startup, rather than in the dockerfile.
- 26.01.16: - Change user of mysqld_safe script to abc, better unclean shutdown handling on restart.
- 23.12.15: - Remove autoupdating, between some version updates the container breaks.
- 12.08.15: - Initial Release.
linuxserver/mastodon¶
Mastodon is a free, open-source social network server based on ActivityPub where users can follow friends and discover new ones..
Supported Architectures¶
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/mastodon:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
| Tag | Available | Description |
|---|---|---|
| latest | ✅ | Stable releases. |
| develop | ✅ | Pre-releases only. |
| glitch | ✅ | glitch-soc fork releases. |
| ## Application Setup |
We provide aliases for the common commands that execute in the correct context so that environment variables from secrets are available to them:
-
To generate keys for
SECRET_KEY_BASE&OTP_SECRETrundocker run --rm -it --entrypoint /bin/bash lscr.io/linuxserver/mastodon generate-secretonce for each. -
To generate keys for
VAPID_PRIVATE_KEY&VAPID_PUBLIC_KEYrundocker run --rm -it --entrypoint /bin/bash lscr.io/linuxserver/mastodon generate-vapid
Both of the secret generation aliases above can be run without any other setup having been carried out.
- To use
tootctlyou can run something likedocker exec -it lscr.io/linuxserver/mastodon /tootctl <command>
Using tootctl requires you to complete the initial Mastodon configuration first.
This container requires separate postgres and redis instances to run.
We support all of the official environment variables for configuration. In place of adding them all to your run/compose you can use an env file such as this example from the upstream project.
For more information check out the mastodon documentation.
Running separate sidekiq instances¶
It is currently only supported to run a single queue per container instance or all queues in a single container instance.
All containers must share the same `/config`` mount and be on a common docker network.
Strict reverse proxies¶
This image automatically redirects to https with a self-signed certificate. If you are using a reverse proxy which validates certificates, you need to disable this check for the container.
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)¶
---
+ mastodon - LinuxServer.io linuxserver/mastodon¶
Mastodon is a free, open-source social network server based on ActivityPub where users can follow friends and discover new ones..
Supported Architectures¶
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/mastodon:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
Tag Available Description latest ✅ Stable releases. develop ✅ Pre-releases only. glitch ✅ glitch-soc fork releases. ## Application Setup
We provide aliases for the common commands that execute in the correct context so that environment variables from secrets are available to them:
-
To generate keys for SECRET_KEY_BASE & OTP_SECRET run docker run --rm -it --entrypoint /bin/bash lscr.io/linuxserver/mastodon generate-secret once for each.
-
To generate keys for VAPID_PRIVATE_KEY & VAPID_PUBLIC_KEY run docker run --rm -it --entrypoint /bin/bash lscr.io/linuxserver/mastodon generate-vapid
Both of the secret generation aliases above can be run without any other setup having been carried out.
- To use
tootctl you can run something like docker exec -it lscr.io/linuxserver/mastodon /tootctl <command>
Using tootctl requires you to complete the initial Mastodon configuration first.
This container requires separate postgres and redis instances to run.
We support all of the official environment variables for configuration. In place of adding them all to your run/compose you can use an env file such as this example from the upstream project.
For more information check out the mastodon documentation.
Running separate sidekiq instances¶
It is currently only supported to run a single queue per container instance or all queues in a single container instance.
All containers must share the same `/config`` mount and be on a common docker network.
Strict reverse proxies¶
This image automatically redirects to https with a self-signed certificate. If you are using a reverse proxy which validates certificates, you need to disable this check for the container.
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)¶
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 80Port for web frontend 443Port for web frontend
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. LOCAL_DOMAIN=example.comThis is the unique identifier of your server in the network. It cannot be safely changed later. REDIS_HOST=redisRedis server hostname REDIS_PORT=6379Redis port DB_HOST=dbPostgres database hostname DB_USER=mastodonPostgres username DB_NAME=mastodonPostgres db name DB_PASS=mastodonPostgres password DB_PORT=5432Portgres port ES_ENABLED=falseEnable or disable Elasticsearch (requires a separate ES instance) SECRET_KEY_BASE=Browser session secret. Changing it will break all active browser sessions. OTP_SECRET=MFA secret. Changing it will break two-factor authentication. VAPID_PRIVATE_KEY=Push notification private key. Changing it will break push notifications. VAPID_PUBLIC_KEY=Push notification public key. Changing it will break push notifications. SMTP_SERVER=mail.example.comSMTP server for email notifications SMTP_PORT=25SMTP server port SMTP_LOGIN=SMTP username SMTP_PASSWORD=SMTP password SMTP_FROM_ADDRESS=notifications@example.comFrom address for emails send from Mastodon S3_ENABLED=falseEnable or disable S3 storage of uploaded files WEB_DOMAIN=mastodon.example.comThis can be set if you want your server identifier to be different to the subdomain hosting Mastodon. See https://docs.joinmastodon.org/admin/config/#basic ES_HOST=esElasticsearch server hostname ES_PORT=9200Elasticsearch port ES_USER=elasticElasticsearch username ES_PASS=elasticElasticsearch password S3_BUCKET=S3 bucket hostname AWS_ACCESS_KEY_ID=S3 bucket access key ID AWS_SECRET_ACCESS_KEY=S3 bucket secret access key S3_ALIAS_HOST=Alternate hostname for object fetching if you are front the S3 connections. SIDEKIQ_ONLY=falseOnly run the sidekiq service in this container instance. For large scale instances that need better queue handling. SIDEKIQ_QUEUE=The name of the sidekiq queue to run in this container. See notes. SIDEKIQ_DEFAULT=falseSet to true on the main container if you're running additional sidekiq instances. It will run the default queue. SIDEKIQ_THREADS=5The number of threads for sidekiq to use. See notes. DB_POOL=5The size of the DB connection pool, must be at least the same as SIDEKIQ_THREADS. See notes.
Volume Mappings (-v)¶
Volume Function /configContains all relevant configuration files.
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:
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:
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 mastodon /bin/bash- To monitor the logs of the container in realtime:
docker logs -f mastodon- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' mastodon- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/mastodon:latest
Versions¶
- 25.05.23: - Adjust apk flags.
- 09.02.23: - Add Glitch branch.
- 09.01.23: - Updated nginx conf to fix bring inline with Mastodon configuration (fixes Elk integration).
- 19.12.22: - Support separate sidekiq queue instances.
- 05.11.22: - Initial Release.
\ No newline at end of file
+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 mastodon /bin/bash- To monitor the logs of the container in realtime:
docker logs -f mastodon- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' mastodon- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/mastodon:latest
Versions¶
- 25.05.23: - Adjust apk flags.
- 09.02.23: - Add Glitch branch.
- 09.01.23: - Updated nginx conf to fix bring inline with Mastodon configuration (fixes Elk integration).
- 19.12.22: - Support separate sidekiq queue instances.
- 05.11.22: - Initial Release.
linuxserver/medusa¶
Medusa is an automatic Video Library Manager for TV Shows. It watches for new episodes of your favorite shows, and when they are posted it does its magic.
Supported Architectures¶
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/medusa:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
Web interface is at <your ip>:8081.
Set paths for downloads, tv-shows to match docker mappings via the webui, for more information check out Medusa.
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)¶
---
+ medusa - LinuxServer.io linuxserver/medusa¶
Medusa is an automatic Video Library Manager for TV Shows. It watches for new episodes of your favorite shows, and when they are posted it does its magic.
Supported Architectures¶
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/medusa:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
Web interface is at <your ip>:8081.
Set paths for downloads, tv-shows to match docker mappings via the webui, for more information check out Medusa.
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)¶
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 8081The port for the Medusa webui
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configMedusa config /downloadsDownload location /tvTV Shows location
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:
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:
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 medusa /bin/bash- To monitor the logs of the container in realtime:
docker logs -f medusa- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' medusa- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/medusa:latest
Versions¶
- 10.08.23: - Bump unrar to 6.2.10.
- 11.07.23: - Rebase to Alpine 3.18.
- 06.07.23: - Deprecate armhf. As announced here
- 13.02.23: - Rebase to Alpine 3.17, migrate to s6v3.
- 12.09.22: - Install ffmpeg for postprocessing.
- 12.08.22: - Bump unrar to 6.1.7.
- 28.02.22: - Install python3 requirements for app.
- 19.01.22: - Rebasing to alpine 3.15.
- 01.06.20: - Rebasing to alpine 3.12.
- 19.12.19: - Rebasing to alpine 3.11.
- 22.09.19: - Switch to python3.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebasing to alpine 3.9.
- 14.01.19: - Adding multi arch and pipeline logic
- 16.08.18: - Rebase to alpine 3.8
- 08.12.17: - Rebase to alpine 3.7
- 29.11.17: - Add py-gdbm for subtitles support
- 26.10.17: - Mediainfo moved from testing to community repo
- 10.10.17: - Use repo version of mediainfo to shorten build time
- 05.08.17: - Internal git pull instead of at runtime
- 25.05.17: - Rebase to alpine 3.6
- 07.02.17: - Rebase to alpine 3.5
- 02.01.17: - Initial Release
\ No newline at end of file
+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 medusa /bin/bash- To monitor the logs of the container in realtime:
docker logs -f medusa- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' medusa- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/medusa:latest
Versions¶
- 10.08.23: - Bump unrar to 6.2.10.
- 11.07.23: - Rebase to Alpine 3.18.
- 06.07.23: - Deprecate armhf. As announced here
- 13.02.23: - Rebase to Alpine 3.17, migrate to s6v3.
- 12.09.22: - Install ffmpeg for postprocessing.
- 12.08.22: - Bump unrar to 6.1.7.
- 28.02.22: - Install python3 requirements for app.
- 19.01.22: - Rebasing to alpine 3.15.
- 01.06.20: - Rebasing to alpine 3.12.
- 19.12.19: - Rebasing to alpine 3.11.
- 22.09.19: - Switch to python3.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebasing to alpine 3.9.
- 14.01.19: - Adding multi arch and pipeline logic
- 16.08.18: - Rebase to alpine 3.8
- 08.12.17: - Rebase to alpine 3.7
- 29.11.17: - Add py-gdbm for subtitles support
- 26.10.17: - Mediainfo moved from testing to community repo
- 10.10.17: - Use repo version of mediainfo to shorten build time
- 05.08.17: - Internal git pull instead of at runtime
- 25.05.17: - Rebase to alpine 3.6
- 07.02.17: - Rebase to alpine 3.5
- 02.01.17: - Initial Release
linuxserver/minetest¶
Minetest (server) is a near-infinite-world block sandbox game and a game engine, inspired by InfiniMiner, Minecraft, and the like.
Supported Architectures¶
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/minetest:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
You can find the world maps, mods folder and config files in /config/.minetest.
If you want to override the advertised port, ensure you add --port in your CLI_ARGS AND ensure the internal port reflects the change, ie; if you set your advertised port to 40000 with --port 40000 then your ports declaration should be 40000:40000/udp
Client and server must be the same version, please browse the tags here to pull the appropriate version for your server:
https://hub.docker.com/r/linuxserver/minetest/tags
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)¶
---
+ minetest - LinuxServer.io linuxserver/minetest¶
Minetest (server) is a near-infinite-world block sandbox game and a game engine, inspired by InfiniMiner, Minecraft, and the like.
Supported Architectures¶
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/minetest:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
You can find the world maps, mods folder and config files in /config/.minetest.
If you want to override the advertised port, ensure you add --port in your CLI_ARGS AND ensure the internal port reflects the change, ie; if you set your advertised port to 40000 with --port 40000 then your ports declaration should be 40000:40000/udp
Client and server must be the same version, please browse the tags here to pull the appropriate version for your server:
https://hub.docker.com/r/linuxserver/minetest/tags
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)¶
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 30000/udpPort Minetest listens on.
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. CLI_ARGS=--gameid minetest --port 30000Optionally specify any CLI variables you want to launch the app with
Volume Mappings (-v)¶
Volume Function /config/.minetestWhere minetest stores config files and maps etc.
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:
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:
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 minetest /bin/bash- To monitor the logs of the container in realtime:
docker logs -f minetest- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' minetest- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/minetest:latest
Versions¶
- 06.07.23: - Deprecate armhf. As announced here
- 09.04.23: - Build logic changes to copy devtest to default games.
- 17.03.23: - Fix CLI_ARGS example in readme.
- 23.02.23: - Rebase to Alpine 3.17, migrate to s6v3.
- 06.08.22: - Update irrlicht deps.
- 02.05.22: - Allow specifying the advertised port.
- 17.03.22: - Install forked irrlicht, add zstd.
- 19.01.22: - Rebasing to alpine 3.15.
- 02.06.20: - Rebasing to alpine 3.12.
- 19.12.19: - Rebasing to alpine 3.11.
- 12.07.19: - Bugfix to support multiple CLI variables.
- 28.06.19: - Rebasing to alpine 3.10.
- 03.06.19: - Adding custom cli vars to options.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 04.03.19: - Rebase to alpine 3.9 to compile 5.0.0 minetest with new build args.
- 14.01.19: - Add pipeline logic and multi arch.
- 08.08.18: - Rebase to alpine 3.8, build from latest release tag instead of master.
- 03.01.18: - Deprecate cpu_core routine lack of scaling.
- 08.12.17: - Rebase to alpine 3.7.
- 30.11.17: - Use cpu core counting routine to speed up build time.
- 26.05.17: - Rebase to alpine 3.6.
- 14.02.17: - Rebase to alpine 3.5.
- 25.11.16: - Rebase to alpine linux, move to main repo.
- 27.02.16: - Bump to latest version.
- 19.02.16: - Change port to UDP, thanks to slashopt for pointing this out.
- 15.02.16: - Make minetest app a service.
- 01.02.16: - Add lua-socket dependency.
- 06.11.15: - Initial Release.
\ No newline at end of file
+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 minetest /bin/bash- To monitor the logs of the container in realtime:
docker logs -f minetest- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' minetest- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/minetest:latest
Versions¶
- 06.07.23: - Deprecate armhf. As announced here
- 09.04.23: - Build logic changes to copy devtest to default games.
- 17.03.23: - Fix CLI_ARGS example in readme.
- 23.02.23: - Rebase to Alpine 3.17, migrate to s6v3.
- 06.08.22: - Update irrlicht deps.
- 02.05.22: - Allow specifying the advertised port.
- 17.03.22: - Install forked irrlicht, add zstd.
- 19.01.22: - Rebasing to alpine 3.15.
- 02.06.20: - Rebasing to alpine 3.12.
- 19.12.19: - Rebasing to alpine 3.11.
- 12.07.19: - Bugfix to support multiple CLI variables.
- 28.06.19: - Rebasing to alpine 3.10.
- 03.06.19: - Adding custom cli vars to options.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 04.03.19: - Rebase to alpine 3.9 to compile 5.0.0 minetest with new build args.
- 14.01.19: - Add pipeline logic and multi arch.
- 08.08.18: - Rebase to alpine 3.8, build from latest release tag instead of master.
- 03.01.18: - Deprecate cpu_core routine lack of scaling.
- 08.12.17: - Rebase to alpine 3.7.
- 30.11.17: - Use cpu core counting routine to speed up build time.
- 26.05.17: - Rebase to alpine 3.6.
- 14.02.17: - Rebase to alpine 3.5.
- 25.11.16: - Rebase to alpine linux, move to main repo.
- 27.02.16: - Bump to latest version.
- 19.02.16: - Change port to UDP, thanks to slashopt for pointing this out.
- 15.02.16: - Make minetest app a service.
- 01.02.16: - Add lua-socket dependency.
- 06.11.15: - Initial Release.
linuxserver/minisatip¶
Minisatip is a multi-threaded satip server version 1.2 that runs under Linux and it was tested with DVB-S, DVB-S2, DVB-T, DVB-T2, DVB-C, DVB-C2, ATSC and ISDB-T cards.
Supported Architectures¶
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/minisatip:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
Best used in conjunction with tvheadend
There is no setup per se, other than adding your cards for passthrough.
You can then use your cards as DVB inputs in apps such as tvheadend.
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)¶
---
+ minisatip - LinuxServer.io linuxserver/minisatip¶
Minisatip is a multi-threaded satip server version 1.2 that runs under Linux and it was tested with DVB-S, DVB-S2, DVB-T, DVB-T2, DVB-C, DVB-C2, ATSC and ISDB-T cards.
Supported Architectures¶
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/minisatip:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
Best used in conjunction with tvheadend
There is no setup per se, other than adding your cards for passthrough.
You can then use your cards as DVB inputs in apps such as tvheadend.
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)¶
Additional runtime parameters¶
In some cases it might be necessary to start minisatip with additional parameters, for example to configure a unicable LNB. Add the parameters you need and restart the container. Be sure to have the right parameters set as adding the wrong once might lead to the container not starting correctly. For a list of minisatip parameters visit Minisatip page.
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 8875Status Page WebUI 554RTSP Port 1900/udpApp Discovery
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. RUN_OPTS=Specify specific run params for minisatip
Volume Mappings (-v)¶
Volume Function /configConfiguration files and minisatip data
Device Mappings (--device)¶
Parameter Function /dev/dvbFor passing through Tv-cards
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:
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:
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 minisatip /bin/bash- To monitor the logs of the container in realtime:
docker logs -f minisatip- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' minisatip- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/minisatip:latest
Versions¶
- 26.07.23: - Build with DDCI=1 for Digital Devices CI support.
- 03.07.23: - Deprecate armhf. As announced here
- 12.11.22: - Rebasing to alpine 3.137, upgrading to s6v3.
- 23.01.21: - Rebasing to alpine 3.13.
- 01.06.20: - Rebasing to alpine 3.12.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebasing to alpine 3.9.
- 20.02.19: - Fix run options.
- 11.02.19: - Add pipeline logic and multi arch.
- 28.08.18: - Rebase to Alpine 3.8.
- 13.12.17: - Rebase to Alpine 3.7.
- 28.05.17: - Rebase to Alpine 3.6.
- 08.02.17: - Rebase to Alpine 3.5 and only compile libs in dvb-apps.
- 14.10.16: - Add version layer information.
- 18.09.16: - Add support for Common Interface.
- 11.09.16: - Add layer badges to README.
- 28.08.16: - Add badges to README.
- 15.08.16: - Initial Release.
\ No newline at end of file
+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 minisatip /bin/bash- To monitor the logs of the container in realtime:
docker logs -f minisatip- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' minisatip- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/minisatip:latest
Versions¶
- 26.07.23: - Build with DDCI=1 for Digital Devices CI support.
- 03.07.23: - Deprecate armhf. As announced here
- 12.11.22: - Rebasing to alpine 3.137, upgrading to s6v3.
- 23.01.21: - Rebasing to alpine 3.13.
- 01.06.20: - Rebasing to alpine 3.12.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebasing to alpine 3.9.
- 20.02.19: - Fix run options.
- 11.02.19: - Add pipeline logic and multi arch.
- 28.08.18: - Rebase to Alpine 3.8.
- 13.12.17: - Rebase to Alpine 3.7.
- 28.05.17: - Rebase to Alpine 3.6.
- 08.02.17: - Rebase to Alpine 3.5 and only compile libs in dvb-apps.
- 14.10.16: - Add version layer information.
- 18.09.16: - Add support for Common Interface.
- 11.09.16: - Add layer badges to README.
- 28.08.16: - Add badges to README.
- 15.08.16: - Initial Release.
linuxserver/mstream¶
mstream is a personal music streaming server. You can use mStream to stream your music from your home computer to any device, anywhere. There are mobile apps available for both Android and iPhone.
Supported Architectures¶
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/mstream:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
Access the webui at http://<your-ip>:3000
Settings are adjusted through the web ui or via editing of config.json. For more information check out Mstream.
IMPORTANT NOTICE:¶
mStream v5 no longer accepts cli arguments for setting the user and password and requires the use of config.json. Therefore, the environment variables USER, PASSWORD and USE_JSON are deprecated.
v4's config.json is not compatible with v5. Existing config.json will be renamed to config.json.v4-bak for your reference and a new default config.json will be created upon upgrade from v4 to v5.
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)¶
---
+ mstream - LinuxServer.io linuxserver/mstream¶
mstream is a personal music streaming server. You can use mStream to stream your music from your home computer to any device, anywhere. There are mobile apps available for both Android and iPhone.
Supported Architectures¶
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/mstream:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
Access the webui at http://<your-ip>:3000
Settings are adjusted through the web ui or via editing of config.json. For more information check out Mstream.
IMPORTANT NOTICE:¶
mStream v5 no longer accepts cli arguments for setting the user and password and requires the use of config.json. Therefore, the environment variables USER, PASSWORD and USE_JSON are deprecated.
v4's config.json is not compatible with v5. Existing config.json will be renamed to config.json.v4-bak for your reference and a new default config.json will be created upon upgrade from v4 to v5.
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)¶
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 3000The port for the mStream webinterface
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configmStream config /musicMusic location
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:
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:
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 mstream /bin/bash- To monitor the logs of the container in realtime:
docker logs -f mstream- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' mstream- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/mstream:latest
Versions¶
- 05.07.23: - Deprecate armhf. As announced here
- 13.02.23: - Rebase to Alpine 3.17, migrate to s6v3.
- 05.04.22: - Move
sync folder to /config. - 02.04.22: - Rebase to alpine 3.15. Fix ffmpeg download.
- 17.05.21: - Deprecating the env vars
USER, PASSWORD and USE_JSON as mStream v5 requires the use of config.json. - 23.01.21: - Rebasing to alpine 3.13.
- 01.06.20: - Rebasing to alpine 3.12.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 18.05.19: - Inital Release
\ No newline at end of file
+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 mstream /bin/bash- To monitor the logs of the container in realtime:
docker logs -f mstream- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' mstream- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/mstream:latest
Versions¶
- 05.07.23: - Deprecate armhf. As announced here
- 13.02.23: - Rebase to Alpine 3.17, migrate to s6v3.
- 05.04.22: - Move
syncfolder to/config. - 02.04.22: - Rebase to alpine 3.15. Fix ffmpeg download.
- 17.05.21: - Deprecating the env vars
USER,PASSWORDandUSE_JSONas mStream v5 requires the use ofconfig.json. - 23.01.21: - Rebasing to alpine 3.13.
- 01.06.20: - Rebasing to alpine 3.12.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 18.05.19: - Inital Release
linuxserver/mullvad-browser¶
The Mullvad Browser is a privacy-focused web browser developed in a collaboration between Mullvad VPN and the Tor Project. It’s designed to minimize tracking and fingerprinting. You could say it’s a Tor Browser to use without the Tor Network. Instead, you can use it with a trustworthy VPN.
Supported Architectures¶
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/mullvad-browser:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ❌ | |
| armhf | ❌ |
Application Setup¶
The application can be accessed at:
- http://yourhost:3000/
- https://yourhost:3001/
VPN Connectivity¶
Generate a Wireguard conf from your VPN provider and copy it into the /config mount with a name of wg0.conf. If a valid conf is found at startup, the container will connect to the VPN and route all traffic over it. This container is not designed for routing other containers traffic and should only be used standlone.
Maintaining local access to attached services¶
When routing traffic via Wireguard you will typically lose access to the webUI. For simple LAN environments you can set the LOCAL_NET environment variable and we will configure routing for you.
If you have more complex network setup, you will need to manually exclude your local networks from being routed via Wireguard by modifying your wg0.conf like so, modifying the HOMENET subnets to match your LAN range(s):
[Interface]
+ mullvad-browser - LinuxServer.io linuxserver/mullvad-browser¶
The Mullvad Browser is a privacy-focused web browser developed in a collaboration between Mullvad VPN and the Tor Project. It’s designed to minimize tracking and fingerprinting. You could say it’s a Tor Browser to use without the Tor Network. Instead, you can use it with a trustworthy VPN.
Supported Architectures¶
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/mullvad-browser:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ❌ armhf ❌
Application Setup¶
The application can be accessed at:
- http://yourhost:3000/
- https://yourhost:3001/
VPN Connectivity¶
Generate a Wireguard conf from your VPN provider and copy it into the /config mount with a name of wg0.conf. If a valid conf is found at startup, the container will connect to the VPN and route all traffic over it. This container is not designed for routing other containers traffic and should only be used standlone.
Maintaining local access to attached services¶
When routing traffic via Wireguard you will typically lose access to the webUI. For simple LAN environments you can set the LOCAL_NET environment variable and we will configure routing for you.
If you have more complex network setup, you will need to manually exclude your local networks from being routed via Wireguard by modifying your wg0.conf like so, modifying the HOMENET subnets to match your LAN range(s):
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 3000Mullvad Browser GUI. 3001Mullvad Browser GUI HTTPS.
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. LOCAL_NET=192.168.0.0/16If using a VPN, set this to your local LAN IP range using CIDR notation. Without it you will be unable to access the web interface. If you have multiple ranges or a complex LAN setup you will need to manage this yourself in the wg0.conf, see the App Setup section for details.
Volume Mappings (-v)¶
Volume Function /configUsers home directory in the container, stores local files and settings
Miscellaneous Options¶
Parameter Function --shm-size=This is needed for any modern website to function like youtube. --security-opt seccomp=unconfinedFor Docker Engine only, many modern gui apps need this to function on older hosts as syscalls are unknown to Docker.
Portainer notice¶
{% hint style="warning" %} This image utilises cap_add or sysctl to work properly. This is not implemented properly in some versions of Portainer, thus this image may not work if deployed through Portainer.
Environment variables from files (Docker secrets)¶
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
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:
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 mullvad-browser /bin/bash- To monitor the logs of the container in realtime:
docker logs -f mullvad-browser- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' mullvad-browser- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/mullvad-browser:latest
Versions¶
- 03.04.23: - Initial release.
\ No newline at end of file
+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 mullvad-browser /bin/bash- To monitor the logs of the container in realtime:
docker logs -f mullvad-browser- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' mullvad-browser- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/mullvad-browser:latest
Versions¶
- 03.04.23: - Initial release.
DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated.
linuxserver/musicbrainz¶
MusicBrainz is an open music encyclopedia that collects music metadata and makes it available to the public.
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/musicbrainz 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 | amd64-latest |
| arm64 | arm64v8-latest |
| armhf | arm32v7-latest |
Usage¶
Here are some example snippets to help you get started creating a container.
docker-compose (recommended)¶
Compatible with docker-compose v2 schemas.
---
+ musicbrainz - LinuxServer.io DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated.
linuxserver/musicbrainz¶
MusicBrainz is an open music encyclopedia that collects music metadata and makes it available to the public.
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/musicbrainz 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 amd64-latest arm64 arm64v8-latest armhf arm32v7-latest
Usage¶
Here are some example snippets to help you get started creating a container.
docker-compose (recommended)¶
Compatible with docker-compose v2 schemas.
---
version: "2.1"
services:
musicbrainz:
@@ -44,4 +44,4 @@
--pull \
-t lscr.io/linuxserver/musicbrainz:latest .
The ARM variants can be built on x86_64 hardware using multiarch/qemu-user-static
Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.
Versions¶
- 23.02.21: - Deprecate image as no one stepped up to take over as maintainer.
- 03.10.20: - Rebase to alpine 3.12, add gettext and move to nodejs-current.
- 17.05.19: - Update DBDefs.pm to schema 25 database.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 02.03.19: - Revert to alpine 3.8 to fix incompatibilities with frontend build tools.
- 19.02.19: - Multi Arch and add pipeline logic, rebase to Alpine 3.9
- 22.08.18: - Bump server version 2018-08-14.
- 30.06.18: - Bump server version 2018-06-30.
- 01.06.18: - Bump server version 2018-05-30 , simplify sed and use yarn instead of npm.
- 14.05.18: - Bump server version 2018-05-09.
- 26.04.18: - Bump server version 2018-04-23.
- 09.02.18: - Bump server version 2018-02-09.
- 24.01.18: - Bump server version 2018-01-24.
- 10.01.18: - Bump server version 2018-01-10.
- 31.11.17: - Bump server version 2017-12-21.
- 30.11.17: - Add NPROC variable to allow number of processes to be set.
- 30.11.17: - Fix linting recommendations.
- 30.11.17: - Remove socket on startup if exists (thanks wtf911) re.
- 24.11.17: - Remove catalyst side bar on new installs.
- 31.10.17: - Bump server version 2017-10-31.
- 20.09.17: - Bump server version 2017-09-18.
- 06.09.17: - Bump server version 2017-09-04.
- 19.07.17: - Bump server version 2017-07-17.
- 21.06.17: - Bump server version 2017-06-19.
- 26.05.17: - Fix later build of postgres using /run instead of /var/run.
- 26.05.17: - Rebase to alpine 3.6.
- 15.05.17: - Schema 24 update, recommend full rebuild with new config.
- 15.04.17: - Bump server version 2017-04-10.
- 04.04.17: - Bump server version 2017-03-27.
- 15.03.17: - Bump server version 2017-03-13.
- 04.03.17: - Bump server version and use nginx to serve web pages.
- 06.02.17: - Rebase to alpine 3.5.
- 16.12.16: - Rebase to alpine linux, entailing almost complete rewrite.
- 14.10.16: - Add version layer information.
- 30.09.16: - Fix umask.
- 10.09.16: - Add layer badges to README.
- 28.08.16: - Add badges to README, move to main repository.
- 20.07.16: - Restructure of docker file for clarity, add maxworkers variable in conjunction with starlet, for parallel requests in multi-core setups, thanks to user baoshan.
- 03.06.16: - Complete rewrite due to schema change. Rebased back to 14.04 direct Using S6 overaly.
- 21.03.16: - Bump to latest server release.
- 16.03.16: - Bump to latest server release.
- 26.02.16: - Bump to latest server release.
- 08.02.16: - Switch to PPA version for redis.
- 03.01.16: - Remove d/l of sitemaps file, missing from last 2 db dumps, move fetch of db/dump higher up initialise routine to allow easier resume of broken downloads.
- 15.12.15: - Per latest musicbrainz blog, switched to production branch,latest stable code is now production branch in place of master.
- 10.12.15: - Initial release date.
\ No newline at end of file
+Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.
Versions¶
- 23.02.21: - Deprecate image as no one stepped up to take over as maintainer.
- 03.10.20: - Rebase to alpine 3.12, add gettext and move to nodejs-current.
- 17.05.19: - Update DBDefs.pm to schema 25 database.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 02.03.19: - Revert to alpine 3.8 to fix incompatibilities with frontend build tools.
- 19.02.19: - Multi Arch and add pipeline logic, rebase to Alpine 3.9
- 22.08.18: - Bump server version 2018-08-14.
- 30.06.18: - Bump server version 2018-06-30.
- 01.06.18: - Bump server version 2018-05-30 , simplify sed and use yarn instead of npm.
- 14.05.18: - Bump server version 2018-05-09.
- 26.04.18: - Bump server version 2018-04-23.
- 09.02.18: - Bump server version 2018-02-09.
- 24.01.18: - Bump server version 2018-01-24.
- 10.01.18: - Bump server version 2018-01-10.
- 31.11.17: - Bump server version 2017-12-21.
- 30.11.17: - Add NPROC variable to allow number of processes to be set.
- 30.11.17: - Fix linting recommendations.
- 30.11.17: - Remove socket on startup if exists (thanks wtf911) re.
- 24.11.17: - Remove catalyst side bar on new installs.
- 31.10.17: - Bump server version 2017-10-31.
- 20.09.17: - Bump server version 2017-09-18.
- 06.09.17: - Bump server version 2017-09-04.
- 19.07.17: - Bump server version 2017-07-17.
- 21.06.17: - Bump server version 2017-06-19.
- 26.05.17: - Fix later build of postgres using /run instead of /var/run.
- 26.05.17: - Rebase to alpine 3.6.
- 15.05.17: - Schema 24 update, recommend full rebuild with new config.
- 15.04.17: - Bump server version 2017-04-10.
- 04.04.17: - Bump server version 2017-03-27.
- 15.03.17: - Bump server version 2017-03-13.
- 04.03.17: - Bump server version and use nginx to serve web pages.
- 06.02.17: - Rebase to alpine 3.5.
- 16.12.16: - Rebase to alpine linux, entailing almost complete rewrite.
- 14.10.16: - Add version layer information.
- 30.09.16: - Fix umask.
- 10.09.16: - Add layer badges to README.
- 28.08.16: - Add badges to README, move to main repository.
- 20.07.16: - Restructure of docker file for clarity, add maxworkers variable in conjunction with starlet, for parallel requests in multi-core setups, thanks to user baoshan.
- 03.06.16: - Complete rewrite due to schema change. Rebased back to 14.04 direct Using S6 overaly.
- 21.03.16: - Bump to latest server release.
- 16.03.16: - Bump to latest server release.
- 26.02.16: - Bump to latest server release.
- 08.02.16: - Switch to PPA version for redis.
- 03.01.16: - Remove d/l of sitemaps file, missing from last 2 db dumps, move fetch of db/dump higher up initialise routine to allow easier resume of broken downloads.
- 15.12.15: - Per latest musicbrainz blog, switched to production branch,latest stable code is now production branch in place of master.
- 10.12.15: - Initial release date.
DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated.
linuxserver/muximux¶
Muximux is a lightweight portal to view & manage your HTPC apps without having to run anything more than a PHP enabled webserver. With Muximux you don't need to keep multiple tabs open, or bookmark the URL to all of your apps.
Supported Architectures¶
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/muximux:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ✅ | arm32v7-<version tag> |
Application Setup¶
Find the web interface at <your-ip>:80 , set apps you wish to use with muximux via the webui. More info:- Muximux
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)¶
---
+ muximux - LinuxServer.io DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated.
linuxserver/muximux¶
Muximux is a lightweight portal to view & manage your HTPC apps without having to run anything more than a PHP enabled webserver. With Muximux you don't need to keep multiple tabs open, or bookmark the URL to all of your apps.
Supported Architectures¶
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/muximux:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ✅ arm32v7-<version tag>
Application Setup¶
Find the web interface at <your-ip>:80 , set apps you wish to use with muximux via the webui. More info:- Muximux
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)¶
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 80WebUI
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Europe/LondonSpecify a timezone to use EG Europe/London.
Volume Mappings (-v)¶
Volume Function /configWhere muximux should store its files.
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:
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:
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 muximux /bin/bash- To monitor the logs of the container in realtime:
docker logs -f muximux- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' muximux- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/muximux:latest
Versions¶
- 21.10.22: - Deprecate image.
- 23.01.21: - Rebasing to alpine 3.13.
- 01.06.20: - Rebasing to alpine 3.12.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebasing to alpine 3.9.
- 16.01.19: - Add pipeline logic and multi arch.
- 13.09.18: - Rebase to alpine 3.8.
- 09.01.18: - Rebase to alpine 3.7.
- 25.05.17: - Rebase to alpine 3.6.
- 12.02.17: - Rebase to alpine 3.5.
- 14.10.16: - Add version layer information.
- 30.09.16: - Rebase to alpine linux.
- 09.09.16: - Add badges to README.
- 22.02.16: - Initial release date.
\ No newline at end of file
+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 muximux /bin/bash- To monitor the logs of the container in realtime:
docker logs -f muximux- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' muximux- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/muximux:latest
Versions¶
- 21.10.22: - Deprecate image.
- 23.01.21: - Rebasing to alpine 3.13.
- 01.06.20: - Rebasing to alpine 3.12.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebasing to alpine 3.9.
- 16.01.19: - Add pipeline logic and multi arch.
- 13.09.18: - Rebase to alpine 3.8.
- 09.01.18: - Rebase to alpine 3.7.
- 25.05.17: - Rebase to alpine 3.6.
- 12.02.17: - Rebase to alpine 3.5.
- 14.10.16: - Add version layer information.
- 30.09.16: - Rebase to alpine linux.
- 09.09.16: - Add badges to README.
- 22.02.16: - Initial release date.
DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated.
linuxserver/mylar¶
Mylar is an automated Comic Book downloader (cbr/cbz) for use with SABnzbd, NZBGet and torrents.
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/mylar 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 | amd64-latest |
| arm64 | arm64v8-latest |
| armhf | arm32v7-latest |
Usage¶
Here are some example snippets to help you get started creating a container from this image.
docker-compose (recommended)¶
Compatible with docker-compose v2 schemas.
---
+ mylar - LinuxServer.io DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated.
linuxserver/mylar¶
Mylar is an automated Comic Book downloader (cbr/cbz) for use with SABnzbd, NZBGet and torrents.
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/mylar 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 amd64-latest arm64 arm64v8-latest armhf arm32v7-latest
Usage¶
Here are some example snippets to help you get started creating a container from this image.
docker-compose (recommended)¶
Compatible with docker-compose v2 schemas.
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 8090WebUI
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation
Volume Mappings (-v)¶
Volume Function /configWhere mylar should store config files. /comicsMap to your comics folder. /downloadsMap to your downloads folder.
Environment variables from files (Docker secrets)¶
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
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:
Application Setup¶
THIS IMAGE IS DEPRECATED. Please migrate to Mylar3.
The web ui for settings etc, is on <your-ip>:8090 For more detailed setup refer Mylar.
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 mylar /bin/bash- To monitor the logs of the container in realtime:
docker logs -f mylar- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' mylar- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/mylar
Versions¶
- 21.12.20: - Deprecated. Please migrate to Mylar3.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 08.05.19: - Re-install requests pip package to downgrade urllib version suitable for mylar.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebasing to alpine 3.9.
- 11.02.19: - Pipeline logic and multi arch.
- 17.08.18: - Rebase to alpine 3.8.
- 06.07.18: - Add
html5lib python package. - 14.06.18: - Add
requests python package. - 12.12.17: - Rebase to alpine 3.7.
- 21.07.17: - Internal git pull instead of at runtime.
- 25.05.17: - Rebase to alpine 3.6.
- 19.02.17: - Use quiet option for cleaner console log, app logs to file anyways.
- 07.02.17: - Rebase to alpine 3.5.
- 14.10.16: - Add version layer information.
- 10.09.16: - Add layer badges to README.
- 28.08.16: - Add badges to README.
- 08.08.16: - Rebase to alpine linux.
- 26.01.16: - Initial release.
\ No newline at end of file
+Application Setup¶
THIS IMAGE IS DEPRECATED. Please migrate to Mylar3.
The web ui for settings etc, is on <your-ip>:8090 For more detailed setup refer Mylar.
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 mylar /bin/bash- To monitor the logs of the container in realtime:
docker logs -f mylar- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' mylar- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/mylar
Versions¶
- 21.12.20: - Deprecated. Please migrate to Mylar3.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 08.05.19: - Re-install requests pip package to downgrade urllib version suitable for mylar.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebasing to alpine 3.9.
- 11.02.19: - Pipeline logic and multi arch.
- 17.08.18: - Rebase to alpine 3.8.
- 06.07.18: - Add
html5libpython package. - 14.06.18: - Add
requestspython package. - 12.12.17: - Rebase to alpine 3.7.
- 21.07.17: - Internal git pull instead of at runtime.
- 25.05.17: - Rebase to alpine 3.6.
- 19.02.17: - Use quiet option for cleaner console log, app logs to file anyways.
- 07.02.17: - Rebase to alpine 3.5.
- 14.10.16: - Add version layer information.
- 10.09.16: - Add layer badges to README.
- 28.08.16: - Add badges to README.
- 08.08.16: - Rebase to alpine linux.
- 26.01.16: - Initial release.
linuxserver/mylar3¶
Mylar3 is an automated Comic Book downloader (cbr/cbz) for use with NZB and torrents written in python. It supports SABnzbd, NZBGET, and many torrent clients in addition to DDL.
Supported Architectures¶
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/mylar3:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
| Tag | Available | Description |
|---|---|---|
| latest | ✅ | Stable Mylar3 releases |
| nightly | ✅ | Commits to Mylar3 python3-dev branch |
| ## Application Setup |
The web ui for settings etc, is on http://SERVERIP:8090 For more detailed setup options, refer to Mylar3.
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)¶
---
+ mylar3 - LinuxServer.io linuxserver/mylar3¶
Mylar3 is an automated Comic Book downloader (cbr/cbz) for use with NZB and torrents written in python. It supports SABnzbd, NZBGET, and many torrent clients in addition to DDL.
Supported Architectures¶
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/mylar3:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
Tag Available Description latest ✅ Stable Mylar3 releases nightly ✅ Commits to Mylar3 python3-dev branch ## Application Setup
The web ui for settings etc, is on http://SERVERIP:8090 For more detailed setup options, refer to Mylar3.
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)¶
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 8090WebUI
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configWhere mylar should store config files. /comicsMap to your comics folder. /downloadsMap to your downloads folder.
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:
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:
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 mylar3 /bin/bash- To monitor the logs of the container in realtime:
docker logs -f mylar3- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' mylar3- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/mylar3:latest
Versions¶
- 16.08.23: - Install unrar from linuxserver repo.
- 10.08.23: - Bump unrar to 6.2.10.
- 11.07.23: - Rebase to Alpine 3.18
- 07.07.23: - Deprecate armhf. As announced here
- 05.03.23: - Rebase to Alpine 3.17.
- 12.10.22: - Rebase to alpine 3.16 and upgrade to s6v3.
- 01.02.22: - Rebase to alpine 3.15.
- 02.11.21: - Rebase to alpine 3.14. Remove
pathlib.py. - 25.05.21: - Add
libwebp support. - 17.05.21: - Add linuxserver wheel index.
- 23.01.21: - Rebasing to alpine 3.13.
- 03.01.21: - Output mylar log to docker log.
- 21.12.20: - Release
nightly tag based on commits to upstream python3-dev branch. - 28.09.20: - Initial release.
\ No newline at end of file
+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 mylar3 /bin/bash- To monitor the logs of the container in realtime:
docker logs -f mylar3- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' mylar3- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/mylar3:latest
Versions¶
- 16.08.23: - Install unrar from linuxserver repo.
- 10.08.23: - Bump unrar to 6.2.10.
- 11.07.23: - Rebase to Alpine 3.18
- 07.07.23: - Deprecate armhf. As announced here
- 05.03.23: - Rebase to Alpine 3.17.
- 12.10.22: - Rebase to alpine 3.16 and upgrade to s6v3.
- 01.02.22: - Rebase to alpine 3.15.
- 02.11.21: - Rebase to alpine 3.14. Remove
pathlib.py. - 25.05.21: - Add
libwebpsupport. - 17.05.21: - Add linuxserver wheel index.
- 23.01.21: - Rebasing to alpine 3.13.
- 03.01.21: - Output mylar log to docker log.
- 21.12.20: - Release
nightlytag based on commits to upstreampython3-devbranch. - 28.09.20: - Initial release.
linuxserver/mysql-workbench¶
MySQL Workbench is a unified visual tool for database architects, developers, and DBAs. MySQL Workbench provides data modeling, SQL development, and comprehensive administration tools for server configuration, user administration, backup, and much more.
Supported Architectures¶
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/mysql-workbench:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ❌ | |
| armhf | ❌ |
Application Setup¶
The application can be accessed at:
- http://yourhost:3000/
- https://yourhost:3001/
Options in all KasmVNC based GUI containers¶
This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.
Optional environment variables¶
| Variable | Description |
|---|---|
| CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default 3000. |
| CUSTOM_HTTPS_PORT | Internal port the container listens on for https if it needs to be swapped from the default 3001. |
| CUSTOM_USER | HTTP Basic auth username, abc is default. |
| PASSWORD | HTTP Basic auth password, abc is default. If unset there will be no auth |
| SUBFOLDER | Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/ |
| TITLE | The page title displayed on the web browser, default "KasmVNC Client". |
| FM_HOME | This is the home directory (landing) for the file manager, default "/config". |
| START_DOCKER | If set to false a container with privilege will not automatically start the DinD Docker setup. |
| DRINODE | If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE /dev/dri/renderD128 |
Optional run configurations¶
| Variable | Description |
|---|---|
--privileged | Will start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE -v /home/user/docker-data:/var/lib/docker. |
-v /var/run/docker.sock:/var/run/docker.sock | Mount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. |
--device /dev/dri:/dev/dri | Mount a GPU into the container, this can be used in conjunction with the DRINODE environment variable to leverage a host video card for GPU accelerated appplications. Only Open Source drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau) |
Lossless mode¶
This container is capable of delivering a true lossless image at a high framerate to your web browser by changing the Stream Quality preset to "Lossless", more information here. In order to use this mode from a non localhost endpoint the HTTPS port on 3001 needs to be used. If using a reverse proxy to port 3000 specific headers will need to be set as outlined here.
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)¶
---
+ mysql-workbench - LinuxServer.io linuxserver/mysql-workbench¶
MySQL Workbench is a unified visual tool for database architects, developers, and DBAs. MySQL Workbench provides data modeling, SQL development, and comprehensive administration tools for server configuration, user administration, backup, and much more.
Supported Architectures¶
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/mysql-workbench:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ❌ armhf ❌
Application Setup¶
The application can be accessed at:
- http://yourhost:3000/
- https://yourhost:3001/
Options in all KasmVNC based GUI containers¶
This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.
Optional environment variables¶
Variable Description CUSTOM_PORT Internal port the container listens on for http if it needs to be swapped from the default 3000. CUSTOM_HTTPS_PORT Internal port the container listens on for https if it needs to be swapped from the default 3001. CUSTOM_USER HTTP Basic auth username, abc is default. PASSWORD HTTP Basic auth password, abc is default. If unset there will be no auth SUBFOLDER Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/ TITLE The page title displayed on the web browser, default "KasmVNC Client". FM_HOME This is the home directory (landing) for the file manager, default "/config". START_DOCKER If set to false a container with privilege will not automatically start the DinD Docker setup. DRINODE If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE /dev/dri/renderD128
Optional run configurations¶
Variable Description --privilegedWill start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE -v /home/user/docker-data:/var/lib/docker. -v /var/run/docker.sock:/var/run/docker.sockMount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. --device /dev/dri:/dev/driMount a GPU into the container, this can be used in conjunction with the DRINODE environment variable to leverage a host video card for GPU accelerated appplications. Only Open Source drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau)
Lossless mode¶
This container is capable of delivering a true lossless image at a high framerate to your web browser by changing the Stream Quality preset to "Lossless", more information here. In order to use this mode from a non localhost endpoint the HTTPS port on 3001 needs to be used. If using a reverse proxy to port 3000 specific headers will need to be set as outlined here.
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)¶
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 3000Mysql Workbench desktop gui. 3001Mysql Workbench desktop gui HTTPS.
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configUsers home directory in the container, stores program settings.
Miscellaneous Options¶
Parameter Function --cap-add=Required for keyring functionality
Environment variables from files (Docker secrets)¶
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
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:
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 mysql-workbench /bin/bash- To monitor the logs of the container in realtime:
docker logs -f mysql-workbench- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' mysql-workbench- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/mysql-workbench:latest
Versions¶
- 20.04.23: - Update app to launch fullscreen.
- 18.03.23: - Rebase to KasmVNC base image.
- 15.09.22: - Migrate to s6v3.
- 26.07.22: - Rebase on jammy.
- 20.04.21: - Rebase on focal.
- 18.01.21: - Update libpython dependency.
- 26.03.20: - Initial release.
\ No newline at end of file
+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 mysql-workbench /bin/bash- To monitor the logs of the container in realtime:
docker logs -f mysql-workbench- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' mysql-workbench- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/mysql-workbench:latest
Versions¶
- 20.04.23: - Update app to launch fullscreen.
- 18.03.23: - Rebase to KasmVNC base image.
- 15.09.22: - Migrate to s6v3.
- 26.07.22: - Rebase on jammy.
- 20.04.21: - Rebase on focal.
- 18.01.21: - Update libpython dependency.
- 26.03.20: - Initial release.
DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated.
linuxserver/nano-discord-bot¶
Nano-discord-bot - A bot used to hook into a self hosted Nano RPC endpoint and discord server to Distribute funds from a faucet account.
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 lsiodev/nano-discord-bot 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 | amd64-latest |
| arm64 | arm64v8-latest |
| armhf | arm32v7-latest |
Usage¶
Here are some example snippets to help you get started creating a container from this image.
docker¶
docker create \
+ nano-discord-bot - LinuxServer.io DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated.
linuxserver/nano-discord-bot¶
Nano-discord-bot - A bot used to hook into a self hosted Nano RPC endpoint and discord server to Distribute funds from a faucet account.
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 lsiodev/nano-discord-bot 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 amd64-latest arm64 arm64v8-latest armhf arm32v7-latest
Usage¶
Here are some example snippets to help you get started creating a container from this image.
docker¶
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
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation WALLET_URL=https://wallet.linuxserver.io/#/nano.linuxserver.io/Hosted wallet endpoint to use. RPC_URL=https://nano.linuxserver.io:7077RPC endpoint to publish blocks to and ingest account information. FAUCET_KEY=XXXXXXXXXXXXXThe private key for your faucet account. DISCORD_KEY=XXXXXXXXXXXXXDiscord api key for the bot. FAUCET_AMOUNT="1000"Amount to distribute to individual Discord users in Nano.
Volume Mappings (-v)¶
Volume Function /configDatabase and Radarr configs
Environment variables from files (Docker secrets)¶
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
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:
Application Setup¶
With the proper environment variables passed to this container it will automatically reach out to your Nano RPC server and Discord Server. More about setting up a hosted Nano network here .
Docker Mods¶
We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) can be accessed via the dynamic badge above.
Support Info¶
- Shell access whilst the container is running:
docker exec -it nano-discord-bot /bin/bash- To monitor the logs of the container in realtime:
docker logs -f nano-discord-bot- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' nano-discord-bot- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lsiodev/nano-discord-bot
Versions¶
- 25.05.20: - Initial Release.
\ No newline at end of file
+Application Setup¶
With the proper environment variables passed to this container it will automatically reach out to your Nano RPC server and Discord Server. More about setting up a hosted Nano network here .
Docker Mods¶
We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) can be accessed via the dynamic badge above.
Support Info¶
- Shell access whilst the container is running:
docker exec -it nano-discord-bot /bin/bash- To monitor the logs of the container in realtime:
docker logs -f nano-discord-bot- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' nano-discord-bot- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lsiodev/nano-discord-bot
Versions¶
- 25.05.20: - Initial Release.
linuxserver/nano-wallet¶
Nano-wallet is a digital payment protocol designed to be accessible and lightweight, with a focus on removing inefficiencies present in other cryptocurrencies. With ultrafast transactions and zero fees on a secure, green and decentralized network, this makes Nano ideal for everyday transactions.
This container is a simple nginx wrapper for the light wallet located here. You will need to pass a valid RPC host when accessing this container.
Supported Architectures¶
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/nano-wallet:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ✅ | arm32v7-<version tag> |
Application Setup¶
This container requires a Nano RPC endpoint to communicate with whether a public network or your own, see here for more information.
Simply access the container at the URL:
http://localhost/#/THE_IP_OR_HOSTNAME_OF_RPC_ENDPOINT
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)¶
---
+ nano-wallet - LinuxServer.io linuxserver/nano-wallet¶
Nano-wallet is a digital payment protocol designed to be accessible and lightweight, with a focus on removing inefficiencies present in other cryptocurrencies. With ultrafast transactions and zero fees on a secure, green and decentralized network, this makes Nano ideal for everyday transactions.
This container is a simple nginx wrapper for the light wallet located here. You will need to pass a valid RPC host when accessing this container.
Supported Architectures¶
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/nano-wallet:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ✅ arm32v7-<version tag>
Application Setup¶
This container requires a Nano RPC endpoint to communicate with whether a public network or your own, see here for more information.
Simply access the container at the URL:
http://localhost/#/THE_IP_OR_HOSTNAME_OF_RPC_ENDPOINT
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:
nano-wallet:
@@ -13,4 +13,4 @@
--restart unless-stopped \
lscr.io/linuxserver/nano-wallet:latest
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 80Webserver port
Environment Variables (-e)¶
Env Function
Volume Mappings (-v)¶
Volume Function
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:
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.
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 nano-wallet /bin/bash- To monitor the logs of the container in realtime:
docker logs -f nano-wallet- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' nano-wallet- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/nano-wallet:latest
Versions¶
- 01.06.20: - Rebasing to alpine 3.12.
- 23.05.20: - Initial Release.
\ No newline at end of file
+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.
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 nano-wallet /bin/bash- To monitor the logs of the container in realtime:
docker logs -f nano-wallet- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' nano-wallet- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/nano-wallet:latest
Versions¶
- 01.06.20: - Rebasing to alpine 3.12.
- 23.05.20: - Initial Release.
linuxserver/nano¶
Nano is a digital payment protocol designed to be accessible and lightweight, with a focus on removing inefficiencies present in other cryptocurrencies. With ultrafast transactions and zero fees on a secure, green and decentralized network, this makes Nano ideal for everyday transactions.
Supported Architectures¶
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/nano:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
| Tag | Available | Description |
|---|---|---|
| latest | ✅ | Stable Nano releases |
| beta | ✅ | Beta Nano releases |
Application Setup¶
Your Genesis account¶
By default this container will launch with a genesis block based on the private key 0000000000000000000000000000000000000000000000000000000000000000, this should obviously only ever be used for testing purposes. Before you run your node you should use a script baked into this image to determine your private key and required environment variables:
docker run --rm --entrypoint /genesis.sh linuxserver/nano
+ nano - LinuxServer.io linuxserver/nano¶
Nano is a digital payment protocol designed to be accessible and lightweight, with a focus on removing inefficiencies present in other cryptocurrencies. With ultrafast transactions and zero fees on a secure, green and decentralized network, this makes Nano ideal for everyday transactions.
Supported Architectures¶
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/nano:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
Tag Available Description latest ✅ Stable Nano releases beta ✅ Beta Nano releases
Application Setup¶
Your Genesis account¶
By default this container will launch with a genesis block based on the private key 0000000000000000000000000000000000000000000000000000000000000000, this should obviously only ever be used for testing purposes. Before you run your node you should use a script baked into this image to determine your private key and required environment variables:
docker run --rm --entrypoint /genesis.sh linuxserver/nano
Generating Genesis block
!!!!!!! ACCOUNT INFO SAVE THIS INFORMATION IT WILL NOT BE SHOWN AGAIN !!!!!!!!
Private Key: CD4CD6B1E5523D4B5AEDD2B1E5A447C6C6797E729A531A95F9AD7937FC7CD9EA
@@ -133,4 +133,4 @@
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 8075Nano communication port 3000RPC interface filtered through a proxy 3001Https RPC interface filtered through a proxy
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Europe/LondonSpecify a timezone to use EG Europe/London PEER_HOST=localhostDefault peer host (can be overidden with an array by command line options) LIVE_GENESIS_PUB=GENESIS_PUBLICGenesis block public key LIVE_GENESIS_ACCOUNT=nano_xxxxxxGenesis block account LIVE_GENESIS_WORK=WORK_FOR_BLOCKGenesis block proof of work LIVE_GENESIS_SIG=BLOCK_SIGNATUREGenesis block signature CLI_OPTIONS=--config node.enable_voting=trueNode run command cli args LMDB_BOOTSTRAP_URL=http://example.com/Nano_64_version_20.7zHTTP/HTTPS endpoint to download a 7z file with the data.ldb to bootstrap to this node
Volume Mappings (-v)¶
Volume Function /configMain storage for config and blockchain
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:
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:
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 nano /bin/bash- To monitor the logs of the container in realtime:
docker logs -f nano- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' nano- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/nano:latest
Versions¶
- 02.06.20: - Rebase to Alpine 3.12.
- 28.05.20: - Add beta tag.
- 17.05.20: - Initial Release.
\ No newline at end of file
+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 nano /bin/bash- To monitor the logs of the container in realtime:
docker logs -f nano- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' nano- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/nano:latest
Versions¶
- 02.06.20: - Rebase to Alpine 3.12.
- 28.05.20: - Add beta tag.
- 17.05.20: - Initial Release.
linuxserver/netbootxyz¶
Netbootxyz is a way to PXE boot various operating system installers or utilities from one place within the BIOS without the need of having to go retrieve the media to run the tool. iPXE is used to provide a user friendly menu from within the BIOS that lets you easily choose the operating system you want along with any specific types of versions or bootable flags.
Supported Architectures¶
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/netbootxyz:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
| Tag | Available | Description |
|---|---|---|
| latest | ✅ | Web application for full self hosting |
| tftp | ✅ | TFTP server only with NETBOOT.XYZ boot files |
| ## Application Setup |
To use this image you need an existing DHCP server where you can set this TFTP server as your DHCP boot destination. This image does not contain a DHCP server nor do we aim to support one in the future. This is simply a TFTP server hosting the latest IPXE kernel builds from netboot.xyz. If you are interested in their project and lack the ability to setup a DHCP server to boot this payload they also have USB stick images you can use available on their downloads page.
Router Setup Examples¶
PFSense¶
Services -> DHCP Server
Set both the option for "TFTP Server" and the options under the Advanced "Network Booting" section. * check enable * Next server- IP used for TFTP Server * Default BIOS file name- netboot.xyz.kpxe * UEFI 32 bit file name- netboot.xyz.efi * UEFI 64 bit file name- netboot.xyz.efi
OPNsense¶
Services -> DHCP Server
Under the Advanced "Network Booting" section. * check enable * Next server- IP of docker host * Default BIOS file name- netboot.xyz.kpxe * UEFI 32 bit file name- netboot.xyz.efi * UEFI 64 bit file name- netboot.xyz.efi
Unifi Security Gateway (with the controller)¶
Networks -> LAN (or the network you want to boot from) -> ADVANCED DHCP OPTIONS * tick Enable network boot * Server- YOURSERVERIP * Filename- netboot.xyz.kpxe
EdgeOS/VyOS¶
Connect via SSH
configure
+ netbootxyz - LinuxServer.io linuxserver/netbootxyz¶
Netbootxyz is a way to PXE boot various operating system installers or utilities from one place within the BIOS without the need of having to go retrieve the media to run the tool. iPXE is used to provide a user friendly menu from within the BIOS that lets you easily choose the operating system you want along with any specific types of versions or bootable flags.
Supported Architectures¶
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/netbootxyz:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
Tag Available Description latest ✅ Web application for full self hosting tftp ✅ TFTP server only with NETBOOT.XYZ boot files ## Application Setup
To use this image you need an existing DHCP server where you can set this TFTP server as your DHCP boot destination. This image does not contain a DHCP server nor do we aim to support one in the future. This is simply a TFTP server hosting the latest IPXE kernel builds from netboot.xyz. If you are interested in their project and lack the ability to setup a DHCP server to boot this payload they also have USB stick images you can use available on their downloads page.
Router Setup Examples¶
PFSense¶
Services -> DHCP Server
Set both the option for "TFTP Server" and the options under the Advanced "Network Booting" section. * check enable * Next server- IP used for TFTP Server * Default BIOS file name- netboot.xyz.kpxe * UEFI 32 bit file name- netboot.xyz.efi * UEFI 64 bit file name- netboot.xyz.efi
OPNsense¶
Services -> DHCP Server
Under the Advanced "Network Booting" section. * check enable * Next server- IP of docker host * Default BIOS file name- netboot.xyz.kpxe * UEFI 32 bit file name- netboot.xyz.efi * UEFI 64 bit file name- netboot.xyz.efi
Unifi Security Gateway (with the controller)¶
Networks -> LAN (or the network you want to boot from) -> ADVANCED DHCP OPTIONS * tick Enable network boot * Server- YOURSERVERIP * Filename- netboot.xyz.kpxe
EdgeOS/VyOS¶
Connect via SSH
configure
set service dhcp-server use-dnsmasq enable
set service dns forwarding options "dhcp-match=set:bios,60,PXEClient:Arch:00000"
set service dns forwarding options "dhcp-boot=tag:bios,netboot.xyz.kpxe,,SERVERIP"
@@ -78,4 +78,4 @@
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 3000Web configuration interface. 69/udpTFTP Port. 80NGINX server for hosting assets.
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. MENU_VERSION=1.9.9Specify a specific version of boot files you want to use from NETBOOT.XYZ (unset pulls latest) PORT_RANGE=30000:30010Specify the port range tftp will use for data transfers (see Wikipedia) SUBFOLDER=/Specify a sobfolder if running this behind a reverse proxy (IE /proxy/)
Volume Mappings (-v)¶
Volume Function /configStorage for boot menu files and web application config /assetsStorage for NETBOOT.XYZ bootable assets (live CDs and other files)
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:
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:
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 netbootxyz /bin/bash- To monitor the logs of the container in realtime:
docker logs -f netbootxyz- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' netbootxyz- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/netbootxyz:latest
Versions¶
- 01.07.23: - Deprecate armhf. As announced here
- 05.03.23: - Rebase to Alpine 3.17.
- 12.10.22: - Rebasing to Alpine 3.16, migrate to s6v3.
- 29.04.21: - Rebasing to alpine 3.13, add SUBFOLDER env variable.
- 01.06.20: - Rebasing to alpine 3.12.
- 19.12.19: - Rebasing to alpine 3.11.
- 13.12.19: - Swapping latest tag over to webapp stack for management.
- 10.12.19: - Adding tftp branch to provide tftp only option to latest users.
- 22.10.19: - Initial release.
\ No newline at end of file
+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 netbootxyz /bin/bash- To monitor the logs of the container in realtime:
docker logs -f netbootxyz- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' netbootxyz- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/netbootxyz:latest
Versions¶
- 01.07.23: - Deprecate armhf. As announced here
- 05.03.23: - Rebase to Alpine 3.17.
- 12.10.22: - Rebasing to Alpine 3.16, migrate to s6v3.
- 29.04.21: - Rebasing to alpine 3.13, add SUBFOLDER env variable.
- 01.06.20: - Rebasing to alpine 3.12.
- 19.12.19: - Rebasing to alpine 3.11.
- 13.12.19: - Swapping latest tag over to webapp stack for management.
- 10.12.19: - Adding tftp branch to provide tftp only option to latest users.
- 22.10.19: - Initial release.
linuxserver/netbox¶
Netbox is an IP address management (IPAM) and data center infrastructure management (DCIM) tool. Initially conceived by the network engineering team at DigitalOcean, NetBox was developed specifically to address the needs of network and infrastructure engineers. It is intended to function as a domain-specific source of truth for network operations.
Supported Architectures¶
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/netbox:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
Netbox requires a postgres database and a redis instance.
Access the WebUI at
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)¶
---
+ netbox - LinuxServer.io linuxserver/netbox¶
Netbox is an IP address management (IPAM) and data center infrastructure management (DCIM) tool. Initially conceived by the network engineering team at DigitalOcean, NetBox was developed specifically to address the needs of network and infrastructure engineers. It is intended to function as a domain-specific source of truth for network operations.
Supported Architectures¶
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/netbox:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
Netbox requires a postgres database and a redis instance.
Access the WebUI at :8000. For more information, check out NetBox.
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)¶
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 8000will map the container's port 8000 to port 8000 on the host
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. SUPERUSER_EMAIL=Email address for admin account SUPERUSER_PASSWORD=Password for admin account ALLOWED_HOST=The hostname you will use to access the app (i.e., netbox.example.com) DB_NAME=Database name (default: netbox) DB_USER=Database user DB_PASSWORD=Database password DB_HOST=Database host (default: postgres) DB_PORT=Database port (defaul: 5432) REDIS_HOST=Redis host (default: redis) REDIS_PORT=Redis port number (default: 6379) REDIS_PASSWORD=Redis password (default: none) REDIS_DB_TASK=Redis database ID for tasks (default: 0) REDIS_DB_CACHE=Redis database ID for caching (default: 1) BASE_PATH=The path you will use to access the app (i.e., /netbox, optional, default: none) REMOTE_AUTH_ENABLED=Enable remote authentication (optional, default: False) REMOTE_AUTH_BACKEND=Python path to the custom Django authentication backend to use for external user authentication (optional, default: netbox.authentication.RemoteUserBackend) REMOTE_AUTH_HEADER=Name of the HTTP header which informs NetBox of the currently authenticated user. (optional, default: HTTP_REMOTE_USER) REMOTE_AUTH_AUTO_CREATE_USER=If true, NetBox will automatically create local accounts for users authenticated via a remote service (optional, default: False) REMOTE_AUTH_DEFAULT_GROUPS=The list of groups to assign a new user account when created using remote authentication (optional, default: []) REMOTE_AUTH_DEFAULT_PERMISSIONS=A mapping of permissions to assign a new user account when created using remote authentication (optional, default: {})
Volume Mappings (-v)¶
Volume Function /configconfig directory volume mapping
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:
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:
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 netbox /bin/bash- To monitor the logs of the container in realtime:
docker logs -f netbox- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' netbox- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/netbox:latest
Versions¶
- 11.06.23: - Rebase to Alpine 3.18, deprecate armhf.
- 14.05.23: - Build local docs on first run.
- 05.03.23: - Rebase to Alpine 3.17.
- 02.11.22: - Rebase to Alpine 3.16, migrate to s6v3.
- 01.08.22: - Remove py3-pillow, add tiff to fix deps.
- 26.07.22: - Add py3-pillow package back on arm to fix build issue.
- 10.12.21: - Remove py3-pillow package to fix dependency issue with 3.2.0.
- 10.12.21: - Rebase to Alpine 3.15.
- 26.04.21: - Added Redis database environment variables.
- 03.02.21: - Added remote authentication environment variables.
- 02.01.21: - Added BASE_PATH environment variable.
- 23.08.20: - Initial Release.
\ No newline at end of file
+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 netbox /bin/bash- To monitor the logs of the container in realtime:
docker logs -f netbox- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' netbox- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/netbox:latest
Versions¶
- 11.06.23: - Rebase to Alpine 3.18, deprecate armhf.
- 14.05.23: - Build local docs on first run.
- 05.03.23: - Rebase to Alpine 3.17.
- 02.11.22: - Rebase to Alpine 3.16, migrate to s6v3.
- 01.08.22: - Remove py3-pillow, add tiff to fix deps.
- 26.07.22: - Add py3-pillow package back on arm to fix build issue.
- 10.12.21: - Remove py3-pillow package to fix dependency issue with 3.2.0.
- 10.12.21: - Rebase to Alpine 3.15.
- 26.04.21: - Added Redis database environment variables.
- 03.02.21: - Added remote authentication environment variables.
- 02.01.21: - Added BASE_PATH environment variable.
- 23.08.20: - Initial Release.
linuxserver/nextcloud¶
Nextcloud gives you access to all your files wherever you are.
Where are your photos and documents? With Nextcloud you pick a server of your choice, at home, in a data center or at a provider. And that is where your files will be. Nextcloud runs on that server, protecting your data and giving you access from your desktop or mobile devices. Through Nextcloud you also access, sync and share your existing data on that FTP drive at the office, a Dropbox or a NAS you have at home.
Supported Architectures¶
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/nextcloud:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
| Tag | Available | Description |
|---|---|---|
| latest | ✅ | Stable Nextcloud releases |
| develop | ✅ | Beta Nextcloud pre-releases only |
| ## Application Setup |
Access the webui at https://<your-ip>:443, for more information check out Nextcloud.
Updating Nextcloud¶
Updating Nextcloud is done by pulling the new image, and recreating the container with it.
It is only possible to upgrade one major version at a time. For example, if you want to upgrade from version 14 to 16, you will have to upgrade from version 14 to 15, then from 15 to 16.
Since all data is stored in the /config and /data volumes, nothing gets lost. The startup script will check for the version in your volume and the installed docker version. If it finds a mismatch, it automatically starts the upgrade process.
Collaborative Editing¶
Nextcloud's built-in collaborative editing packages (Collabora/CODE and OnlyOffice) only work on x86_64 systems with glibc, and therefore they are not compatible with our images. You should create separate containers for them and set them up in Nextcloud with their respective connector addons.
If (auto) installed, those built-in packages may cause instability and should be removed.
Custom App Directories¶
If you are using custom app directories you will need to make the custom folder(s) you are using available to the web server. The recommended way to do this with our container is to add a volume. Ex:
volumes:
+ nextcloud - LinuxServer.io linuxserver/nextcloud¶
Nextcloud gives you access to all your files wherever you are.
Where are your photos and documents? With Nextcloud you pick a server of your choice, at home, in a data center or at a provider. And that is where your files will be. Nextcloud runs on that server, protecting your data and giving you access from your desktop or mobile devices. Through Nextcloud you also access, sync and share your existing data on that FTP drive at the office, a Dropbox or a NAS you have at home.
Supported Architectures¶
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/nextcloud:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
Tag Available Description latest ✅ Stable Nextcloud releases develop ✅ Beta Nextcloud pre-releases only ## Application Setup
Access the webui at https://<your-ip>:443, for more information check out Nextcloud.
Updating Nextcloud¶
Updating Nextcloud is done by pulling the new image, and recreating the container with it.
It is only possible to upgrade one major version at a time. For example, if you want to upgrade from version 14 to 16, you will have to upgrade from version 14 to 15, then from 15 to 16.
Since all data is stored in the /config and /data volumes, nothing gets lost. The startup script will check for the version in your volume and the installed docker version. If it finds a mismatch, it automatically starts the upgrade process.
Collaborative Editing¶
Nextcloud's built-in collaborative editing packages (Collabora/CODE and OnlyOffice) only work on x86_64 systems with glibc, and therefore they are not compatible with our images. You should create separate containers for them and set them up in Nextcloud with their respective connector addons.
If (auto) installed, those built-in packages may cause instability and should be removed.
Custom App Directories¶
If you are using custom app directories you will need to make the custom folder(s) you are using available to the web server. The recommended way to do this with our container is to add a volume. Ex:
Afterwards, you can set "path" => OC::$SERVERROOT . "/your_custom_apps_folder", in your config.php file, per the official documentation.
Strict reverse proxies¶
This image uses a self-signed certificate by default. This naturally means the scheme is https. If you are using a reverse proxy which validates certificates, you need to disable this check for the container.
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)¶
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 443WebUI
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configNextcloud configs. /dataYour personal data.
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:
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:
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 nextcloud /bin/bash- To monitor the logs of the container in realtime:
docker logs -f nextcloud- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' nextcloud- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/nextcloud:latest
Versions¶
- 14.08.23: - Add develop branch.
- 25.06.23: - Move Nextcloud installation inside container. Remove CLI updater. See changes announcement.
- 21.06.23: - Existing users should update
/config/nginx/site-confs/default.conf - Security fix for real ip settings. - 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 13.04.23: - Move ssl.conf include to default.conf.
- 21.03.23: - Add php81-sysvsem as new dep for v26. Update default X-Robots-Tag to `noindex, nofollow``.
- 02.03.23: - Set permissions on crontabs during init.
- 20.01.23: - Rebase to alpine 3.17 with php8.1.
- 10.10.22: - Rebasing to alpine 3.15 with php8. Restructure nginx configs (see changes announcement).
- 30.09.22: - Disabled
output_buffering as per [nextcloud docs](https://docs.nextcloud.com/server/latest/admin_manual/configuration_files/big_file_upload_configuration.html - 21.05.22: - Update version check endpoint.
- 28.04.22: - Increase OPCache interned strings buffered setting to 16.
- 14.04.22: - Nginx default site config updated for v23 (existing users should delete
/config/nginx/site-confs/default.conf and restart the container). Fix LDAP connection. - 11.09.21: - Rebasing to alpine 3.14
- 21.03.21: - Publish
php8 tag for testing. - 25.02.21: - Nginx default site config updated for v21 (existing users should delete
/config/nginx/site-confs/default.conf and restart the container). - 21.01.21: - Fix php iconv (was breaking the mail addon). If installed, attempt to remove broken CODE Server app during startup.
- 20.01.21: - Increase php fcgi timeout to prevent 504 Gateway timeout errors (existing users should delete
/config/nginx/site-confs/default.conf and restart the container). - 16.01.21: - Rebasing to alpine 3.13. Users with issues on 32-bit arm, see this article.
- 12.08.20: - Various updates to default site config, including added support for webfinger (existing users should delete
/config/nginx/site-confs/default.conf and restart the container). - 03.06.20: - Rebasing to alpine 3.12
- 03.06.20: - Add php7-bcmath and php7-fileinfo
- 31.05.20: - Add aliases for occ and updater.phar
- 31.03.20: - Allow crontab to be user customized, fix logrotate.
- 17.01.20: - Updated php.ini defaults and site config, including an optional HSTS directive (existing users should delete
/config/nginx/site-confs/default.conf and restart the container). - 19.12.19: - Rebasing to alpine 3.11.
- 18.11.19: - Nginx default site config updated for v17 (existing users should delete
/config/nginx/site-confs/default.conf and restart the container). - 28.10.19: - Change cronjob to run every 5 minutes.
- 24.10.19: - Nginx default site config updated due to CVE-2019-11043 (existing users should delete
/config/nginx/site-confs/default.conf and restart the container). - 14.07.19: - Download nextcloud during build time.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 27.02.19: - Updating base nginx config to sync up with v15 requirements.
- 22.02.19: - Rebasing to alpine 3.9.
- 28.01.19: - Add pipeline logic and multi arch.
- 25.01.19: - Add php7-phar for occ upgrades.
- 05.09.18: - Rebase to alpine 3.8.
- 11.06.18: - Use latest rather than specific version for initial install.
- 26.04.18: - Bump default install to 13.0.1.
- 06.02.18: - Bump default install to 13.0.0.
- 26.01.18: - Rebase to alpine 3.7, bump default install to 12.0.5.
- 12.12.17: - Bump default install to 12.0.4, fix continuation lines.
- 15.10.17: - Sed php.ini for opcache requirements in newer nextcloud versions.
- 20.09.17: - Bump default install to 12.0.3.
- 19.08.17: - Bump default install to 12.0.2.
- 25.05.17: - Rebase to alpine 3.6.
- 22.05.17: - Update to nextcloud 12.0, adding required dependecies and note about commenting out SAMEORIGIN; line.
- 03.05.17: - Use community repo of memcache.
- 07.03.17: - Release into main repository and upgrade to php7 and Alpine 3.5.
\ No newline at end of file
+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 nextcloud /bin/bash- To monitor the logs of the container in realtime:
docker logs -f nextcloud- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' nextcloud- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/nextcloud:latest
Versions¶
- 14.08.23: - Add develop branch.
- 25.06.23: - Move Nextcloud installation inside container. Remove CLI updater. See changes announcement.
- 21.06.23: - Existing users should update
/config/nginx/site-confs/default.conf- Security fix for real ip settings. - 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 13.04.23: - Move ssl.conf include to default.conf.
- 21.03.23: - Add php81-sysvsem as new dep for v26. Update default X-Robots-Tag to `noindex, nofollow``.
- 02.03.23: - Set permissions on crontabs during init.
- 20.01.23: - Rebase to alpine 3.17 with php8.1.
- 10.10.22: - Rebasing to alpine 3.15 with php8. Restructure nginx configs (see changes announcement).
- 30.09.22: - Disabled
output_bufferingas per [nextcloud docs](https://docs.nextcloud.com/server/latest/admin_manual/configuration_files/big_file_upload_configuration.html - 21.05.22: - Update version check endpoint.
- 28.04.22: - Increase OPCache interned strings buffered setting to 16.
- 14.04.22: - Nginx default site config updated for v23 (existing users should delete
/config/nginx/site-confs/default.confand restart the container). Fix LDAP connection. - 11.09.21: - Rebasing to alpine 3.14
- 21.03.21: - Publish
php8tag for testing. - 25.02.21: - Nginx default site config updated for v21 (existing users should delete
/config/nginx/site-confs/default.confand restart the container). - 21.01.21: - Fix php iconv (was breaking the mail addon). If installed, attempt to remove broken CODE Server app during startup.
- 20.01.21: - Increase php fcgi timeout to prevent 504 Gateway timeout errors (existing users should delete
/config/nginx/site-confs/default.confand restart the container). - 16.01.21: - Rebasing to alpine 3.13. Users with issues on 32-bit arm, see this article.
- 12.08.20: - Various updates to default site config, including added support for webfinger (existing users should delete
/config/nginx/site-confs/default.confand restart the container). - 03.06.20: - Rebasing to alpine 3.12
- 03.06.20: - Add php7-bcmath and php7-fileinfo
- 31.05.20: - Add aliases for occ and updater.phar
- 31.03.20: - Allow crontab to be user customized, fix logrotate.
- 17.01.20: - Updated php.ini defaults and site config, including an optional HSTS directive (existing users should delete
/config/nginx/site-confs/default.confand restart the container). - 19.12.19: - Rebasing to alpine 3.11.
- 18.11.19: - Nginx default site config updated for v17 (existing users should delete
/config/nginx/site-confs/default.confand restart the container). - 28.10.19: - Change cronjob to run every 5 minutes.
- 24.10.19: - Nginx default site config updated due to CVE-2019-11043 (existing users should delete
/config/nginx/site-confs/default.confand restart the container). - 14.07.19: - Download nextcloud during build time.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 27.02.19: - Updating base nginx config to sync up with v15 requirements.
- 22.02.19: - Rebasing to alpine 3.9.
- 28.01.19: - Add pipeline logic and multi arch.
- 25.01.19: - Add php7-phar for occ upgrades.
- 05.09.18: - Rebase to alpine 3.8.
- 11.06.18: - Use latest rather than specific version for initial install.
- 26.04.18: - Bump default install to 13.0.1.
- 06.02.18: - Bump default install to 13.0.0.
- 26.01.18: - Rebase to alpine 3.7, bump default install to 12.0.5.
- 12.12.17: - Bump default install to 12.0.4, fix continuation lines.
- 15.10.17: - Sed php.ini for opcache requirements in newer nextcloud versions.
- 20.09.17: - Bump default install to 12.0.3.
- 19.08.17: - Bump default install to 12.0.2.
- 25.05.17: - Rebase to alpine 3.6.
- 22.05.17: - Update to nextcloud 12.0, adding required dependecies and note about commenting out SAMEORIGIN; line.
- 03.05.17: - Use community repo of memcache.
- 07.03.17: - Release into main repository and upgrade to php7 and Alpine 3.5.
linuxserver/nginx¶
Nginx is a simple webserver with php support. The config files reside in /config for easy user customization.
Supported Architectures¶
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/nginx:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
Add your web files to /config/www for hosting.
Modify the nginx, php and site config files under /config as needed
Protip: This container is best combined with a sql server, e.g. mariadb
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)¶
---
+ nginx - LinuxServer.io linuxserver/nginx¶
Nginx is a simple webserver with php support. The config files reside in /config for easy user customization.
Supported Architectures¶
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/nginx:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
Add your web files to /config/www for hosting.
Modify the nginx, php and site config files under /config as needed
Protip: This container is best combined with a sql server, e.g. mariadb
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)¶
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 80http 443https
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configContains your www content and all relevant configuration files.
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:
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:
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 nginx /bin/bash- To monitor the logs of the container in realtime:
docker logs -f nginx- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' nginx- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/nginx:latest
Versions¶
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 16.01.23: - Remove nchan module because it keeps causing crashes.
- 22.12.22: - Rebase to Alpine 3.17 with PHP 8.1, migrate to s6v3.
- 20.08.22: - Rebasing to alpine 3.15 with php8. Restructure nginx configs (see changes announcement).
- 22.05.22: - Install nginx version from 3.14.
- 01.07.21: - Rebasing to alpine 3.14.
- 24.06.21: - Update default nginx conf folder.
- 12.04.21: - Add php7-gmp and php7-pecl-mailparse.
- 13.02.21: - Remove php7-pecl-imagick (it now installs the full imagemagick with too much crud). Users can install it via this docker mod.
- 09.02.21: - Rebasing to alpine 3.13. Add nginx mods brotli and dav-ext. Remove nginx mods lua and lua-upstream (due to regression over the last couple of years).
- 08.09.20: - Add php7-xsl.
- 01.06.20: - Rebasing to alpine 3.12.
- 18.04.20: - Fix unwanted shutdown of the container.
- 11.03.20: - Add php7-sodium.
- 18.02.20: - Add geoip2, suppress lua warning.
- 19.12.19: - Rebasing to alpine 3.11.
- 18.12.19: - Add php7-imap and php7-pecl-apcu.
- 13.11.19: - Add php7-pdo_odbc.
- 24.10.19: - Add php7-pecl-imagick.
- 06.08.19: - Add php7-bcmath, ph7-pear, php7-xmlrpc and php7-ftp.
- 02.08.19: - Add php7-ldap.
- 28.06.19: - Rebasing to alpine 3.10.
- 08.05.19: - Remove default.conf when nginx is upgraded in downstream image.
- 30.04.19: - Add php-redis.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 02.03.19: - Add php intl and posix modules.
- 28.02.19: - Add php7-opcache, remove memcached service due to issues on aarch64 (let us know if you need to enable it).
- 22.02.19: - Rebasing to alpine 3.9.
- 18.11.18: - Attempt to upgrade packages during build.
- 28.09.18: - Multi-arch image.
- 17.08.18: - Rebase to alpine 3.8, inherit nginx.conf from nginx baseimage.
- 11.05.18: - Add php pgsql support.
- 19.04.18: - Bind memcached to localhost only, add php7-sqlite3.
- 05.01.18: - Rebase to alpine 3.7.
- 08.11.17: - Add php7 soap module.
- 31.10.17: - Add php7 exif and xmlreader modules.
- 30.09.17: - Copy additional root files into image.
- 24.09.17: - Add memcached service.
- 31.08.17: - Add php7-phar.
- 14.07.17: - Enable modules dynamically in nginx.conf.
- 22.06.17: - Add various nginx modules and enable all modules in the default nginx.conf.
- 05.06.17: - Add php7-bz2.
- 25.05.17: - Rebase to alpine 3.6.
- 18.04.17: - Add php7-sockets.
- 27.02.17: - Rebase to alpine 3.5, update to nginx 1.10.2 and php7.
- 14.10.16: - Add version layer information.
- 10.09.16: - Add badges to README.
- 05.12.15: - Intial Release.
\ No newline at end of file
+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 nginx /bin/bash- To monitor the logs of the container in realtime:
docker logs -f nginx- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' nginx- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/nginx:latest
Versions¶
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 16.01.23: - Remove nchan module because it keeps causing crashes.
- 22.12.22: - Rebase to Alpine 3.17 with PHP 8.1, migrate to s6v3.
- 20.08.22: - Rebasing to alpine 3.15 with php8. Restructure nginx configs (see changes announcement).
- 22.05.22: - Install nginx version from 3.14.
- 01.07.21: - Rebasing to alpine 3.14.
- 24.06.21: - Update default nginx conf folder.
- 12.04.21: - Add php7-gmp and php7-pecl-mailparse.
- 13.02.21: - Remove php7-pecl-imagick (it now installs the full imagemagick with too much crud). Users can install it via this docker mod.
- 09.02.21: - Rebasing to alpine 3.13. Add nginx mods brotli and dav-ext. Remove nginx mods lua and lua-upstream (due to regression over the last couple of years).
- 08.09.20: - Add php7-xsl.
- 01.06.20: - Rebasing to alpine 3.12.
- 18.04.20: - Fix unwanted shutdown of the container.
- 11.03.20: - Add php7-sodium.
- 18.02.20: - Add geoip2, suppress lua warning.
- 19.12.19: - Rebasing to alpine 3.11.
- 18.12.19: - Add php7-imap and php7-pecl-apcu.
- 13.11.19: - Add php7-pdo_odbc.
- 24.10.19: - Add php7-pecl-imagick.
- 06.08.19: - Add php7-bcmath, ph7-pear, php7-xmlrpc and php7-ftp.
- 02.08.19: - Add php7-ldap.
- 28.06.19: - Rebasing to alpine 3.10.
- 08.05.19: - Remove default.conf when nginx is upgraded in downstream image.
- 30.04.19: - Add php-redis.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 02.03.19: - Add php intl and posix modules.
- 28.02.19: - Add php7-opcache, remove memcached service due to issues on aarch64 (let us know if you need to enable it).
- 22.02.19: - Rebasing to alpine 3.9.
- 18.11.18: - Attempt to upgrade packages during build.
- 28.09.18: - Multi-arch image.
- 17.08.18: - Rebase to alpine 3.8, inherit nginx.conf from nginx baseimage.
- 11.05.18: - Add php pgsql support.
- 19.04.18: - Bind memcached to localhost only, add php7-sqlite3.
- 05.01.18: - Rebase to alpine 3.7.
- 08.11.17: - Add php7 soap module.
- 31.10.17: - Add php7 exif and xmlreader modules.
- 30.09.17: - Copy additional root files into image.
- 24.09.17: - Add memcached service.
- 31.08.17: - Add php7-phar.
- 14.07.17: - Enable modules dynamically in nginx.conf.
- 22.06.17: - Add various nginx modules and enable all modules in the default nginx.conf.
- 05.06.17: - Add php7-bz2.
- 25.05.17: - Rebase to alpine 3.6.
- 18.04.17: - Add php7-sockets.
- 27.02.17: - Rebase to alpine 3.5, update to nginx 1.10.2 and php7.
- 14.10.16: - Add version layer information.
- 10.09.16: - Add badges to README.
- 05.12.15: - Intial Release.
linuxserver/ngircd¶
Ngircd is a free, portable and lightweight Internet Relay Chat server for small or private networks, developed under the GNU General Public License (GPL). It is easy to configure, can cope with dynamic IP addresses, and supports IPv6, SSL-protected connections as well as PAM for authentication. It is written from scratch and not based on the original IRCd.
Supported Architectures¶
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/ngircd:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
- To setup ngircd you will need to edit
/config/ngircd.confwhich is created the first time the container is run, edit the file and restart the container to implement any config changes. - For information see the ngircd site here.
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)¶
---
+ ngircd - LinuxServer.io linuxserver/ngircd¶
Ngircd is a free, portable and lightweight Internet Relay Chat server for small or private networks, developed under the GNU General Public License (GPL). It is easy to configure, can cope with dynamic IP addresses, and supports IPv6, SSL-protected connections as well as PAM for authentication. It is written from scratch and not based on the original IRCd.
Supported Architectures¶
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/ngircd:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
- To setup ngircd you will need to edit
/config/ngircd.conf which is created the first time the container is run, edit the file and restart the container to implement any config changes. - For information see the ngircd site here.
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)¶
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 6667ngircd port
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configWhere ngircd.conf is stored
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:
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:
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 ngircd /bin/bash- To monitor the logs of the container in realtime:
docker logs -f ngircd- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' ngircd- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/ngircd:latest
Versions¶
- 12.07.23: - Rebase to Alpine 3.18.
- 01.07.23: - Deprecate armhf. As announced here
- 05.03.23: - Rebase to Alpine 3.17.
- 11.10.22: - Rebasing to alpine 3.16, migrate to s6v3.
- 23.01.21: - Rebasing to alpine 3.13.
- 01.06.20: - Rebasing to alpine 3.12.
- 19.12.19: - Rebasing to alpine 3.11.
- 04.07.19: - Initial release.
\ No newline at end of file
+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 ngircd /bin/bash- To monitor the logs of the container in realtime:
docker logs -f ngircd- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' ngircd- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/ngircd:latest
Versions¶
- 12.07.23: - Rebase to Alpine 3.18.
- 01.07.23: - Deprecate armhf. As announced here
- 05.03.23: - Rebase to Alpine 3.17.
- 11.10.22: - Rebasing to alpine 3.16, migrate to s6v3.
- 23.01.21: - Rebasing to alpine 3.13.
- 01.06.20: - Rebasing to alpine 3.12.
- 19.12.19: - Rebasing to alpine 3.11.
- 04.07.19: - Initial release.
DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated.
linuxserver/nntp2nntp¶
Nntp2nntp proxy allow you to use your NNTP Account from multiple systems, each with own user name and password. It fully supports SSL and you can also limit the access to proxy with SSL certificates. nntp2nntp proxy is very simple and pretty fast.
Warning¶
Whilst we know of no nntp2nntp security issues the upstream code for this project has received no changes since 06.08.15 and is likely abandoned permanently. For this reason we strongly recommend you do not make this application public facing and if you must do so other layers of security and SSL should be considered an absolute bare minimum requirement. We see this proxy being used primarily on a LAN so that all the users NNTP applications can share a common set of internal credentials allowing for central managment of the upstream account e.g change provider, server, thread limits for all applications with one global config change.
Supported Architectures¶
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/nntp2nntp:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
Edit sample config file config/nntp2nntp.conf with upstream provider details and rename the local users.
New user passwords can be created by running the password hash generator
docker exec -it nntp2nntp /usr/bin/nntp2nntp.py pass
+ nntp2nntp - LinuxServer.io DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated.
linuxserver/nntp2nntp¶
Nntp2nntp proxy allow you to use your NNTP Account from multiple systems, each with own user name and password. It fully supports SSL and you can also limit the access to proxy with SSL certificates. nntp2nntp proxy is very simple and pretty fast.
Warning¶
Whilst we know of no nntp2nntp security issues the upstream code for this project has received no changes since 06.08.15 and is likely abandoned permanently. For this reason we strongly recommend you do not make this application public facing and if you must do so other layers of security and SSL should be considered an absolute bare minimum requirement. We see this proxy being used primarily on a LAN so that all the users NNTP applications can share a common set of internal credentials allowing for central managment of the upstream account e.g change provider, server, thread limits for all applications with one global config change.
Supported Architectures¶
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/nntp2nntp:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
Edit sample config file config/nntp2nntp.conf with upstream provider details and rename the local users.
New user passwords can be created by running the password hash generator
entering the desired password and copying the resulting string to the relevant user line in /config/nntp2nntp.conf Example with a user called Dave and with a password of password
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)¶
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 1563will map the container's port 1563 to port 1563 on the host
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. PUID=<yourUID>specify your UID PGID=<yourGID>specify your GID
Volume Mappings (-v)¶
Volume Function /configthis will store config on the docker host
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:
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:
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 nntp2nntp /bin/bash- To monitor the logs of the container in realtime:
docker logs -f nntp2nntp- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' nntp2nntp- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/nntp2nntp:latest
Versions¶
- 04.07.23: - Deprecate container.
- 04.07.23: - Deprecate armhf. As announced here
- 10.10.22: - Rebase to Alpine 3.15.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.04.19: - Multiarch builds and build from Github fork.
- 15.05.18: - Initial Release.
\ No newline at end of file
+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 nntp2nntp /bin/bash- To monitor the logs of the container in realtime:
docker logs -f nntp2nntp- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' nntp2nntp- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/nntp2nntp:latest
Versions¶
- 04.07.23: - Deprecate container.
- 04.07.23: - Deprecate armhf. As announced here
- 10.10.22: - Rebase to Alpine 3.15.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.04.19: - Multiarch builds and build from Github fork.
- 15.05.18: - Initial Release.
DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. nzbget has been deprecated by its developers. Please consider switching to SABnzbd https://github.com/linuxserver/docker-sabnzbd
linuxserver/nzbget¶
Nzbget is a usenet downloader, written in C++ and designed with performance in mind to achieve maximum download speed by using very little system resources.
Supported Architectures¶
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/nzbget:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ✅ | arm32v7-<version tag> |
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
| Tag | Available | Description |
|---|---|---|
| latest | ✅ | Stable nzbget releases |
| testing | ✅ | nzbget pre-releases |
Application Setup¶
Webui can be found at <your-ip>:6789 and the default login details (change ASAP) are
login:nzbget, password:tegbzn6789
To allow scheduling, from the webui set the time correction value in settings/logging.
To change umask settings.
scroll to bottom, set umask like this (example shown for unraid)
You can add an additional mount point for intermediate unpacking folder with:-
-v </path/to/intermedia_unpacking_folder>:/intermediate
for example, and changing the setting for InterDir in the PATHS tab of settings to /intermediate
Media folders¶
We have set /downloads as a optional path, this is because it is the easiest way to get started. While easy to use, it has some drawbacks. Mainly losing the ability to atomic move (TL;DR instant file moves, rather than copy+delete) files while processing content.
Use the optional paths if you dont understand, or dont want hardlinks/atomic moves.
The folks over at servarr.com wrote a good write-up on how to get started with this.
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)¶
---
+ nzbget - LinuxServer.io DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. nzbget has been deprecated by its developers. Please consider switching to SABnzbd https://github.com/linuxserver/docker-sabnzbd
linuxserver/nzbget¶
Nzbget is a usenet downloader, written in C++ and designed with performance in mind to achieve maximum download speed by using very little system resources.
Supported Architectures¶
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/nzbget:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ✅ arm32v7-<version tag>
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
Tag Available Description latest ✅ Stable nzbget releases testing ✅ nzbget pre-releases
Application Setup¶
Webui can be found at <your-ip>:6789 and the default login details (change ASAP) are
login:nzbget, password:tegbzn6789
To allow scheduling, from the webui set the time correction value in settings/logging.
To change umask settings.
scroll to bottom, set umask like this (example shown for unraid)
You can add an additional mount point for intermediate unpacking folder with:-
-v </path/to/intermedia_unpacking_folder>:/intermediate
for example, and changing the setting for InterDir in the PATHS tab of settings to /intermediate
Media folders¶
We have set /downloads as a optional path, this is because it is the easiest way to get started. While easy to use, it has some drawbacks. Mainly losing the ability to atomic move (TL;DR instant file moves, rather than copy+delete) files while processing content.
Use the optional paths if you dont understand, or dont want hardlinks/atomic moves.
The folks over at servarr.com wrote a good write-up on how to get started with this.
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)¶
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 6789WebUI
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Europe/LondonSpecify a timezone to use EG Europe/London. NZBGET_USER=nzbgetSpecify the user for web authentication. NZBGET_PASS=tegbzn6789Specify the password for web authentication.
Volume Mappings (-v)¶
Volume Function /configNZBGet App data. /downloadsLocation of downloads on disk.
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:
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:
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 nzbget /bin/bash- To monitor the logs of the container in realtime:
docker logs -f nzbget- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' nzbget- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/nzbget:latest
Versions¶
- 31.12.22: - Deprecate image. Please consider switching to SABnzbd https://github.com/linuxserver/docker-sabnzbd
- 27.11.22: - Advanced notice: This image will be deprecated on 2022-12-31. Please consider switching to SABnzbd https://github.com/linuxserver/docker-sabnzbd
- 13.11.22: - Rebase master to 3.16, migrate to s6v3.
- 12.08.22: - Bump unrar to 6.1.7.
- 22.02.22: - Rebase to alpine 3.15, add six and python 7zip tools, allow env variables for credentials.
- 04.07.21: - Rebase to alpine 3.14.
- 28.05.21: - Add linuxserver wheel index.
- 23.01.21: - Rebasing to alpine 3.13.
- 26.10.20: - Fix python dependencies.
- 24.08.20: - Fix ignored umask environment variable.
- 08.06.20: - Symlink python3 bin to python.
- 01.06.20: - Rebasing to alpine 3.12. Removing python2.
- 13.05.20: - Add rarfile python package (for DeepUnrar).
- 01.01.20: - Add python3 alongside python2 during transition.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 13.06.19: - Add apprise, chardet & pynzbget packages.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 25.02.19: - Rebasing to alpine 3.9.
- 20.01.19: - Add pipeline logic and multi arch, build from source.
- 21.08.18: - Rebase to alpine 3.8.
- 20.02.18: - Add note about supplemental mount point for intermediate unpacking.
- 13.12.17: - Rebase to alpine 3.7.
- 02.09.17: - Place app in subfolder rather than /app.
- 12.07.17: - Add inspect commands to README, move to jenkins build and push.
- 28.05.17: - Rebase to alpine 3.6.
- 20.04.17: - Add testing branch.
- 06.02.17: - Rebase to alpine 3.5.
- 30.09.16: - Fix umask.
- 09.09.16: - Add layer badges to README.
- 27.08.16: - Add badges to README, perms fix on /app to allow updates.
- 19.08.16: - Rebase to alpine linux.
- 18.08.15: - Now useing latest version of unrar beta and implements the universal installer method.
\ No newline at end of file
+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 nzbget /bin/bash- To monitor the logs of the container in realtime:
docker logs -f nzbget- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' nzbget- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/nzbget:latest
Versions¶
- 31.12.22: - Deprecate image. Please consider switching to SABnzbd https://github.com/linuxserver/docker-sabnzbd
- 27.11.22: - Advanced notice: This image will be deprecated on 2022-12-31. Please consider switching to SABnzbd https://github.com/linuxserver/docker-sabnzbd
- 13.11.22: - Rebase master to 3.16, migrate to s6v3.
- 12.08.22: - Bump unrar to 6.1.7.
- 22.02.22: - Rebase to alpine 3.15, add six and python 7zip tools, allow env variables for credentials.
- 04.07.21: - Rebase to alpine 3.14.
- 28.05.21: - Add linuxserver wheel index.
- 23.01.21: - Rebasing to alpine 3.13.
- 26.10.20: - Fix python dependencies.
- 24.08.20: - Fix ignored umask environment variable.
- 08.06.20: - Symlink python3 bin to python.
- 01.06.20: - Rebasing to alpine 3.12. Removing python2.
- 13.05.20: - Add rarfile python package (for DeepUnrar).
- 01.01.20: - Add python3 alongside python2 during transition.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 13.06.19: - Add apprise, chardet & pynzbget packages.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 25.02.19: - Rebasing to alpine 3.9.
- 20.01.19: - Add pipeline logic and multi arch, build from source.
- 21.08.18: - Rebase to alpine 3.8.
- 20.02.18: - Add note about supplemental mount point for intermediate unpacking.
- 13.12.17: - Rebase to alpine 3.7.
- 02.09.17: - Place app in subfolder rather than /app.
- 12.07.17: - Add inspect commands to README, move to jenkins build and push.
- 28.05.17: - Rebase to alpine 3.6.
- 20.04.17: - Add testing branch.
- 06.02.17: - Rebase to alpine 3.5.
- 30.09.16: - Fix umask.
- 09.09.16: - Add layer badges to README.
- 27.08.16: - Add badges to README, perms fix on /app to allow updates.
- 19.08.16: - Rebase to alpine linux.
- 18.08.15: - Now useing latest version of unrar beta and implements the universal installer method.
linuxserver/nzbhydra2¶
Nzbhydra2 is a meta search application for NZB indexers, the "spiritual successor" to NZBmegasearcH, and an evolution of the original application NZBHydra.
It provides easy access to a number of raw and newznab based indexers. The application NZBHydra 2 is replacing NZBHydra 1 and supports migrating from V1. Be wary that there may be some compatibility issues for those migrating from V1 to V2, so ensure you back up your old configuration before moving over to the new version. NOTE: The last version that supports migration is linuxserver/nzbhydra2:v2.10.2-ls49
Supported Architectures¶
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/nzbhydra2:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
| Tag | Available | Description |
|---|---|---|
| latest | ✅ | Stable releases |
| dev | ✅ | Prereleases from their GitHub |
| ## Application Setup |
The web interface is at <your ip>:5076 , to set up indexers and connections to your nzb download applications.
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)¶
---
+ nzbhydra2 - LinuxServer.io linuxserver/nzbhydra2¶
Nzbhydra2 is a meta search application for NZB indexers, the "spiritual successor" to NZBmegasearcH, and an evolution of the original application NZBHydra.
It provides easy access to a number of raw and newznab based indexers. The application NZBHydra 2 is replacing NZBHydra 1 and supports migrating from V1. Be wary that there may be some compatibility issues for those migrating from V1 to V2, so ensure you back up your old configuration before moving over to the new version. NOTE: The last version that supports migration is linuxserver/nzbhydra2:v2.10.2-ls49
Supported Architectures¶
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/nzbhydra2:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
Tag Available Description latest ✅ Stable releases dev ✅ Prereleases from their GitHub ## Application Setup
The web interface is at <your ip>:5076 , to set up indexers and connections to your nzb download applications.
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)¶
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 5076WebUI
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configWhere nzbhydra2 should store config files. /downloadsNZB download folder.
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:
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:
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 nzbhydra2 /bin/bash- To monitor the logs of the container in realtime:
docker logs -f nzbhydra2- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' nzbhydra2- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/nzbhydra2:latest
Versions¶
- 04.07.23: - Deprecate armhf. As announced here
- 22.01.23: - Update release URL for arch-specific packages.
- 20.01.23: - Update dependencies for v5.
- 10.12.22: - Bump master JRE to v17. Default mapIpToHost to false.
- 11.09.22: - Migrate to s6v3.
- 03.05.22: - Rebase to Jammy.
- 18.04.22: - Rebase to Alpine 3.15.
- 01.05.20: - Reorganize container, Relocate app to /app/nzbhydra2/bin, Create /app/nzbhydra2/package_info, Use nzbhydra2wrapperPy3.py from zip.
- 14.04.20: - Correct Name, Hydra2 -> NZBHydra2.
- 08.01.20: - Switch to python3.
- 05.01.20: - Add dev tag for prereleases.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 11.02.19: - Add pipeline logic and multi arch.
- 18.08.18: - Bump java version to 10, (bionic currently refers to it as version 11).
- 10.08.18: - Rebase to ubuntu bionic.
- 15.04.18: - Change to port 5076 in the Dockerfile.
- 11.01.18: - Initial Release.
\ No newline at end of file
+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 nzbhydra2 /bin/bash- To monitor the logs of the container in realtime:
docker logs -f nzbhydra2- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' nzbhydra2- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/nzbhydra2:latest
Versions¶
- 04.07.23: - Deprecate armhf. As announced here
- 22.01.23: - Update release URL for arch-specific packages.
- 20.01.23: - Update dependencies for v5.
- 10.12.22: - Bump master JRE to v17. Default mapIpToHost to false.
- 11.09.22: - Migrate to s6v3.
- 03.05.22: - Rebase to Jammy.
- 18.04.22: - Rebase to Alpine 3.15.
- 01.05.20: - Reorganize container, Relocate app to /app/nzbhydra2/bin, Create /app/nzbhydra2/package_info, Use nzbhydra2wrapperPy3.py from zip.
- 14.04.20: - Correct Name, Hydra2 -> NZBHydra2.
- 08.01.20: - Switch to python3.
- 05.01.20: - Add dev tag for prereleases.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 11.02.19: - Add pipeline logic and multi arch.
- 18.08.18: - Bump java version to 10, (bionic currently refers to it as version 11).
- 10.08.18: - Rebase to ubuntu bionic.
- 15.04.18: - Change to port 5076 in the Dockerfile.
- 11.01.18: - Initial Release.
linuxserver/ombi¶
Ombi allows you to host your own Plex Request and user management system. If you are sharing your Plex server with other users, allow them to request new content using an easy to manage interface! Manage all your requests for Movies and TV with ease, leave notes for the user and get notification when a user requests something. Allow your users to post issues against their requests so you know there is a problem with the audio etc. Even automatically send them weekly newsletters of new content that has been added to your Plex server!
Supported Architectures¶
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/ombi:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
| Tag | Available | Description |
|---|---|---|
| latest | ✅ | Stable Ombi releases |
| development | ✅ | Releases from the develop branch of Ombi |
| ## Application Setup |
Access the webui at <your-ip>:3579. Follow the setup wizard on initial install. Then configure the required services.
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)¶
---
+ ombi - LinuxServer.io linuxserver/ombi¶
Ombi allows you to host your own Plex Request and user management system. If you are sharing your Plex server with other users, allow them to request new content using an easy to manage interface! Manage all your requests for Movies and TV with ease, leave notes for the user and get notification when a user requests something. Allow your users to post issues against their requests so you know there is a problem with the audio etc. Even automatically send them weekly newsletters of new content that has been added to your Plex server!
Supported Architectures¶
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/ombi:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
Tag Available Description latest ✅ Stable Ombi releases development ✅ Releases from the develop branch of Ombi ## Application Setup
Access the webui at <your-ip>:3579. Follow the setup wizard on initial install. Then configure the required services.
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)¶
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 3579web gui
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. BASE_URL=/ombiSubfolder can optionally be defined as an env variable for reverse proxies. Keep in mind that once this value is defined, the gui setting for base url no longer works. To use the gui setting, remove this env variable.
Volume Mappings (-v)¶
Volume Function /configContains all relevant configuration files.
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:
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:
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 ombi /bin/bash- To monitor the logs of the container in realtime:
docker logs -f ombi- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' ombi- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/ombi:latest
Versions¶
- 01.07.23: - Deprecate armhf. As announced here
- 11.09.22: - Migrate to s6v3.
- 01.05.22: - Rebase to Jammy.
- 26.04.21: - Update tarball name, allow for v4 builds in stable.
- 18.01.21: - Update upstream repo. Deprecate
v4-preview tag, which is merged to development tag upstream. - 14.04.20: - Add Ombi donate links.
- 10.05.19: - Added an optional env variable for base url setting.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Clarify info on tags and development builds.
- 25.01.19: - Add info on tags and development builds.
- 09.01.19: - Switch to multi-arch builds and add aarch64 image.
- 11.03.18: - Add HOME env to Dockerfile.
- 05.03.18: - Switch to Ombi v3 stable based on .net core.
- 26.01.18: - Fix continuation lines.
- 16.04.17: - Switch to using inhouse mono baseimage.
- 17.02.17: - Initial Release.
\ No newline at end of file
+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 ombi /bin/bash- To monitor the logs of the container in realtime:
docker logs -f ombi- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' ombi- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/ombi:latest
Versions¶
- 01.07.23: - Deprecate armhf. As announced here
- 11.09.22: - Migrate to s6v3.
- 01.05.22: - Rebase to Jammy.
- 26.04.21: - Update tarball name, allow for v4 builds in stable.
- 18.01.21: - Update upstream repo. Deprecate
v4-previewtag, which is merged todevelopmenttag upstream. - 14.04.20: - Add Ombi donate links.
- 10.05.19: - Added an optional env variable for base url setting.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Clarify info on tags and development builds.
- 25.01.19: - Add info on tags and development builds.
- 09.01.19: - Switch to multi-arch builds and add aarch64 image.
- 11.03.18: - Add HOME env to Dockerfile.
- 05.03.18: - Switch to Ombi v3 stable based on .net core.
- 26.01.18: - Fix continuation lines.
- 16.04.17: - Switch to using inhouse mono baseimage.
- 17.02.17: - Initial Release.
linuxserver/openssh-server¶
Openssh-server is a sandboxed environment that allows ssh access without giving keys to the entire server. Giving ssh access via private key often means giving full access to the server. This container creates a limited and sandboxed environment that others can ssh into. The users only have access to the folders mapped and the processes running inside this container.
Supported Architectures¶
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/openssh-server:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
If PUBLIC_KEY or PUBLIC_KEY_FILE, or PUBLIC_KEY_DIR variables are set, the specified keys will automatically be added to authorized_keys. If not, the keys can manually be added to /config/.ssh/authorized_keys and the container should be restarted. Removing PUBLIC_KEY or PUBLIC_KEY_FILE variables from docker run environment variables will not remove the keys from authorized_keys. PUBLIC_KEY_FILE and PUBLIC_KEY_DIR can be used with docker secrets.
We provide the ability to set and allow password based access via the PASSWORD_ACCESS and USER_PASSWORD variables, though we as an organization discourage using password auth for public facing ssh endpoints.
Connect to server via ssh -i /path/to/private/key -p PORT USER_NAME@SERVERIP
Setting SUDO_ACCESS to true by itself will allow passwordless sudo. USER_PASSWORD and USER_PASSWORD_FILE allow setting an optional sudo password.
The users only have access to the folders mapped and the processes running inside this container. Add any volume mappings you like for the users to have access to. To install packages or services for users to access, use the LinuxServer container customization methods described in this blog article.
Sample use case is when a server admin would like to have automated incoming backups from a remote server to the local server, but they might not want all the other admins of the remote server to have full access to the local server. This container can be set up with a mounted folder for incoming backups, and rsync installed via LinuxServer container customization described above, so that the incoming backups can proceed, but remote server and its admins' access would be limited to the backup folder.
It is also possible to run multiple copies of this container with different ports mapped, different folders mounted and access to different private keys for compartmentalized access.
TIPS¶
You can volume map your own text file to /etc/motd to override the message displayed upon connection. You can optionally set the docker argument hostname
Key Generation¶
This container has a helper script to generate an ssh private/public key. In order to generate a key please run:
docker run --rm -it --entrypoint /keygen.sh linuxserver/openssh-server
+ openssh-server - LinuxServer.io linuxserver/openssh-server¶
Openssh-server is a sandboxed environment that allows ssh access without giving keys to the entire server. Giving ssh access via private key often means giving full access to the server. This container creates a limited and sandboxed environment that others can ssh into. The users only have access to the folders mapped and the processes running inside this container.
Supported Architectures¶
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/openssh-server:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
If PUBLIC_KEY or PUBLIC_KEY_FILE, or PUBLIC_KEY_DIR variables are set, the specified keys will automatically be added to authorized_keys. If not, the keys can manually be added to /config/.ssh/authorized_keys and the container should be restarted. Removing PUBLIC_KEY or PUBLIC_KEY_FILE variables from docker run environment variables will not remove the keys from authorized_keys. PUBLIC_KEY_FILE and PUBLIC_KEY_DIR can be used with docker secrets.
We provide the ability to set and allow password based access via the PASSWORD_ACCESS and USER_PASSWORD variables, though we as an organization discourage using password auth for public facing ssh endpoints.
Connect to server via ssh -i /path/to/private/key -p PORT USER_NAME@SERVERIP
Setting SUDO_ACCESS to true by itself will allow passwordless sudo. USER_PASSWORD and USER_PASSWORD_FILE allow setting an optional sudo password.
The users only have access to the folders mapped and the processes running inside this container. Add any volume mappings you like for the users to have access to. To install packages or services for users to access, use the LinuxServer container customization methods described in this blog article.
Sample use case is when a server admin would like to have automated incoming backups from a remote server to the local server, but they might not want all the other admins of the remote server to have full access to the local server. This container can be set up with a mounted folder for incoming backups, and rsync installed via LinuxServer container customization described above, so that the incoming backups can proceed, but remote server and its admins' access would be limited to the backup folder.
It is also possible to run multiple copies of this container with different ports mapped, different folders mounted and access to different private keys for compartmentalized access.
TIPS¶
You can volume map your own text file to /etc/motd to override the message displayed upon connection. You can optionally set the docker argument hostname
Key Generation¶
This container has a helper script to generate an ssh private/public key. In order to generate a key please run:
Then simply follow the prompts. The keys generated by this script are only displayed on your console output, so make sure to save them somewhere after generation.
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)¶
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 2222ssh port
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. PUBLIC_KEY=yourpublickeyOptional ssh public key, which will automatically be added to authorized_keys. PUBLIC_KEY_FILE=/path/to/fileOptionally specify a file containing the public key (works with docker secrets). PUBLIC_KEY_DIR=/path/to/directory/containing/_only_/pubkeysOptionally specify a directory containing the public keys (works with docker secrets). PUBLIC_KEY_URL=https://github.com/username.keysOptionally specify a URL containing the public key. SUDO_ACCESS=falseSet to true to allow linuxserver.io, the ssh user, sudo access. Without USER_PASSWORD set, this will allow passwordless sudo access. PASSWORD_ACCESS=falseSet to true to allow user/password ssh access. You will want to set USER_PASSWORD or USER_PASSWORD_FILE as well. USER_PASSWORD=passwordOptionally set a sudo password for linuxserver.io, the ssh user. If this or USER_PASSWORD_FILE are not set but SUDO_ACCESS is set to true, the user will have passwordless sudo access. USER_PASSWORD_FILE=/path/to/fileOptionally specify a file that contains the password. This setting supersedes the USER_PASSWORD option (works with docker secrets). USER_NAME=linuxserver.ioOptionally specify a user name (Default:linuxserver.io)
Volume Mappings (-v)¶
Volume Function /configContains all relevant configuration files.
Miscellaneous Options¶
Parameter Function --hostname=Optionally the hostname can be defined.
Environment variables from files (Docker secrets)¶
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
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:
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 openssh-server /bin/bash- To monitor the logs of the container in realtime:
docker logs -f openssh-server- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' openssh-server- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/openssh-server:latest
Versions¶
- 12.06.23: - Rebase to Alpine 3.18, deprecate armhf. As announced here
- 05.03.23: - Rebase to Alpine 3.17.
- 18.10.22: - Fix wrong behavior of password/passwordless sudo
- 11.10.22: - Rebase to Alpine 3.16, migrate to s6v3.
- 15.09.22: - add netcat-openbsd with support for proxies.
- 18.07.22: - Fix service perms to comply with upgrade to s6 v3.
- 16.04.22: - Rebase to alpine 3.15.
- 16.11.21: - Add PUBLIC_KEY_URL option
- 28.06.21: - Rebasing to alpine 3.14. Add support for PAM.
- 10.02.21: - Rebasing to alpine 3.13. Add openssh-client for scp.
- 21.10.20: - Implement s6-log for openssh, which adds local timestamps to logs and can be used with a log parser like fail2ban.
- 20.10.20: - Set umask for sftp.
- 01.06.20: - Rebasing to alpine 3.12.
- 18.01.20: - Add key generation script.
- 13.01.20: - Add openssh-sftp-server.
- 19.12.19: - Rebasing to alpine 3.11.
- 17.10.19: - Initial Release.
\ No newline at end of file
+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 openssh-server /bin/bash- To monitor the logs of the container in realtime:
docker logs -f openssh-server- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' openssh-server- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/openssh-server:latest
Versions¶
- 12.06.23: - Rebase to Alpine 3.18, deprecate armhf. As announced here
- 05.03.23: - Rebase to Alpine 3.17.
- 18.10.22: - Fix wrong behavior of password/passwordless sudo
- 11.10.22: - Rebase to Alpine 3.16, migrate to s6v3.
- 15.09.22: - add netcat-openbsd with support for proxies.
- 18.07.22: - Fix service perms to comply with upgrade to s6 v3.
- 16.04.22: - Rebase to alpine 3.15.
- 16.11.21: - Add PUBLIC_KEY_URL option
- 28.06.21: - Rebasing to alpine 3.14. Add support for PAM.
- 10.02.21: - Rebasing to alpine 3.13. Add openssh-client for scp.
- 21.10.20: - Implement s6-log for openssh, which adds local timestamps to logs and can be used with a log parser like fail2ban.
- 20.10.20: - Set umask for sftp.
- 01.06.20: - Rebasing to alpine 3.12.
- 18.01.20: - Add key generation script.
- 13.01.20: - Add openssh-sftp-server.
- 19.12.19: - Rebasing to alpine 3.11.
- 17.10.19: - Initial Release.
DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. We recommend our wireguard image instead for vpn: https://github.com/linuxserver/docker-wireguard
linuxserver/openvpn-as¶
Openvpn-as is a full featured secure network tunneling VPN software solution that integrates OpenVPN server capabilities, enterprise management capabilities, simplified OpenVPN Connect UI, and OpenVPN Client software packages that accommodate Windows, MAC, Linux, Android, and iOS environments. OpenVPN Access Server supports a wide range of configurations, including secure and granular remote access to internal network and/ or private cloud network resources and applications with fine-grained access control.
Supported Architectures¶
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/openvpn-as 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 |
Version Tags¶
This image provides various versions that are available via tags. latest tag usually provides the latest stable version. Others are considered under development and caution must be exercised when using them.
| Tag | Description |
|---|---|
| latest | DEPRECATED, no longer updated - Stable releases based on ubuntu bionic |
| xenial | DEPRECATED, no longer updated - Stable releases based on ubuntu xenial |
Application Setup¶
The admin interface is available at https://DOCKER-HOST-IP:943/admin (assuming bridge mode) with a default user/password of admin/password
During first login, make sure that the "Authentication" in the webui is set to "Local" instead of "PAM". Then set up the user accounts with their passwords (user accounts created under PAM do not survive container update or recreation).
The "admin" account is a system (PAM) account and after container update or recreation, its password reverts back to the default. It is highly recommended to block this user's access for security reasons: 1) Create another user and set as an admin, 2) Log in as the new user, 3) Delete the "admin" user in the gui, 4) Modify the as.conf file under config/etc and replace the line boot_pam_users.0=admin with ~~#boot_pam_users.0=admin~~ boot_pam_users.0=kjhvkhv (this only has to be done once and will survive container recreation)
* IMPORTANT NOTE: Commenting out the first pam user in as.conf creates issues in 2.7.5. To make it work while still blocking pam user access, uncomment that line and change admin to a random nonexistent user as described above.
To ensure your devices can connect to your VPN properly, goto Configuration -> Network Settings -> and change the "Hostname or IP Address" section to either your domain name or public ip address.
Usage¶
Here are some example snippets to help you get started creating a container from this image.
docker-compose (recommended)¶
Compatible with docker-compose v2 schemas.
---
+ openvpn-as - LinuxServer.io DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. We recommend our wireguard image instead for vpn: https://github.com/linuxserver/docker-wireguard
linuxserver/openvpn-as¶
Openvpn-as is a full featured secure network tunneling VPN software solution that integrates OpenVPN server capabilities, enterprise management capabilities, simplified OpenVPN Connect UI, and OpenVPN Client software packages that accommodate Windows, MAC, Linux, Android, and iOS environments. OpenVPN Access Server supports a wide range of configurations, including secure and granular remote access to internal network and/ or private cloud network resources and applications with fine-grained access control.
Supported Architectures¶
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/openvpn-as 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
Version Tags¶
This image provides various versions that are available via tags. latest tag usually provides the latest stable version. Others are considered under development and caution must be exercised when using them.
Tag Description latest DEPRECATED, no longer updated - Stable releases based on ubuntu bionic xenial DEPRECATED, no longer updated - Stable releases based on ubuntu xenial
Application Setup¶
The admin interface is available at https://DOCKER-HOST-IP:943/admin (assuming bridge mode) with a default user/password of admin/password
During first login, make sure that the "Authentication" in the webui is set to "Local" instead of "PAM". Then set up the user accounts with their passwords (user accounts created under PAM do not survive container update or recreation).
The "admin" account is a system (PAM) account and after container update or recreation, its password reverts back to the default. It is highly recommended to block this user's access for security reasons: 1) Create another user and set as an admin, 2) Log in as the new user, 3) Delete the "admin" user in the gui, 4) Modify the as.conf file under config/etc and replace the line boot_pam_users.0=admin with ~~#boot_pam_users.0=admin~~ boot_pam_users.0=kjhvkhv (this only has to be done once and will survive container recreation)
* IMPORTANT NOTE: Commenting out the first pam user in as.conf creates issues in 2.7.5. To make it work while still blocking pam user access, uncomment that line and change admin to a random nonexistent user as described above.
To ensure your devices can connect to your VPN properly, goto Configuration -> Network Settings -> and change the "Hostname or IP Address" section to either your domain name or public ip address.
Usage¶
Here are some example snippets to help you get started creating a container from this image.
docker-compose (recommended)¶
Compatible with docker-compose v2 schemas.
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 943Admin GUI port. 9443TCP port. 1194/udpUDP port.
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Europe/LondonSpecify a timezone to use EG Europe/London. INTERFACE=eth0With bridge networking, leave it as eth0 (or don't include at all), if host or macvlan, set it to your host's network interface, found by running ifconfig
Volume Mappings (-v)¶
Volume Function /configWhere openvpn-as should store configuration files.
Environment variables from files (Docker secrets)¶
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
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:
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 openvpn-as /bin/bash- To monitor the logs of the container in realtime:
docker logs -f openvpn-as- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' openvpn-as- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/openvpn-as
Versions¶
- 15.06.20: - Deprecate.
- 15.06.20: - Add fixes for 2.9.0.
- 04.11.20: -
xenial tag is deprecated and there will be no further releases for that tag. - 22.06.20: - Added Support for persistent Customization Folders.
- 26.03.20: - Switch to using the openvpn-as repo for packages.
- 29.08.19: - Update Application Setup instructions in readme to fix 2.7.5 login issue for existing users.
- 27.08.19: - Add new clients package to install and upgrade process.
- 22.08.19: - Prevent auto-start of openvpn after first time install, before configuration is completed.
- 25.07.19: - Create a xenial branch/tag and rebase master/latest to bionic.
- 07.04.19: - Fix first time config.
- 03.04.19: - Big rewrite of the install and update logic of openvpn-as to fix breaking changes (should fix updating from 2.6.1 to 2.7.3), added mysql-client for cluster support.
- 14.03.19: - Update deb package URL.
- 21.02.19: - Rebase to xenial due to incompatibility issues on some older host OSes.
- 12.02.19: - Rename github repo to match the docker hub repo and container name.
- 07.02.19: - Add pipeline logic and multi arch.
- 31.01.19: - Add port mappings to docker create sample in readme.
- 26.01.19: - Removed
privileged and host networking requirements, added cap-add=NET_ADMIN requirement instead. INTERFACE no longer needs to be defined as in bridge mode, it will use the container's eth0 interface by default. - 19.12.18: - Bump to version 2.6.1.
- 10.07.18: - Bump to version 2.5.2.
- 23.03.18: - Bump to version 2.5.
- 14.12.17: - Consolidate layers and fix continuation lines.
- 25.10.17: - Bump to version 2.1.12.
- 18.08.17: - Switch default authentication method to local, update readme on how to deactivate the admin user.
- 31.07.17: - Fix updates of existing openvpn-as installs.
- 07.07.17: - Bump to version 2.1.9.
- 31.10.16: - Bump to version 2.1.4.
- 14.10.16: - Add version layer information.
- 13.09.16: - Rebuild due to push error to hub on last build.
- 10.09.16: - Add layer badges to README.
- 28.08.16: - Add badges to README.
- 01.08.16: - Rebase to xenial.
- 18.09.15: - Initial Release.
\ No newline at end of file
+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 openvpn-as /bin/bash- To monitor the logs of the container in realtime:
docker logs -f openvpn-as- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' openvpn-as- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/openvpn-as
Versions¶
- 15.06.20: - Deprecate.
- 15.06.20: - Add fixes for 2.9.0.
- 04.11.20: -
xenialtag is deprecated and there will be no further releases for that tag. - 22.06.20: - Added Support for persistent Customization Folders.
- 26.03.20: - Switch to using the openvpn-as repo for packages.
- 29.08.19: - Update Application Setup instructions in readme to fix 2.7.5 login issue for existing users.
- 27.08.19: - Add new clients package to install and upgrade process.
- 22.08.19: - Prevent auto-start of openvpn after first time install, before configuration is completed.
- 25.07.19: - Create a xenial branch/tag and rebase master/latest to bionic.
- 07.04.19: - Fix first time config.
- 03.04.19: - Big rewrite of the install and update logic of openvpn-as to fix breaking changes (should fix updating from 2.6.1 to 2.7.3), added mysql-client for cluster support.
- 14.03.19: - Update deb package URL.
- 21.02.19: - Rebase to xenial due to incompatibility issues on some older host OSes.
- 12.02.19: - Rename github repo to match the docker hub repo and container name.
- 07.02.19: - Add pipeline logic and multi arch.
- 31.01.19: - Add port mappings to docker create sample in readme.
- 26.01.19: - Removed
privilegedandhostnetworking requirements, addedcap-add=NET_ADMINrequirement instead.INTERFACEno longer needs to be defined as in bridge mode, it will use the container's eth0 interface by default. - 19.12.18: - Bump to version 2.6.1.
- 10.07.18: - Bump to version 2.5.2.
- 23.03.18: - Bump to version 2.5.
- 14.12.17: - Consolidate layers and fix continuation lines.
- 25.10.17: - Bump to version 2.1.12.
- 18.08.17: - Switch default authentication method to local, update readme on how to deactivate the admin user.
- 31.07.17: - Fix updates of existing openvpn-as installs.
- 07.07.17: - Bump to version 2.1.9.
- 31.10.16: - Bump to version 2.1.4.
- 14.10.16: - Add version layer information.
- 13.09.16: - Rebuild due to push error to hub on last build.
- 10.09.16: - Add layer badges to README.
- 28.08.16: - Add badges to README.
- 01.08.16: - Rebase to xenial.
- 18.09.15: - Initial Release.
linuxserver/openvscode-server¶
Openvscode-server provides a version of VS Code that runs a server on a remote machine and allows access through a modern web browser.
Supported Architectures¶
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/openvscode-server:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
| Tag | Available | Description |
|---|---|---|
| latest | ✅ | Stable releases |
| insiders | ✅ | Insiders releases |
| ## Application Setup |
If CONNECTION_TOKEN or CONNECTION_SECRET env vars are set, you can access the webui at http://<your-ip>:3000/?tkn=supersecrettoken (replace supersecrettoken with the value set). If not, you can access the webui at http://<your-ip>:3000.
For github integration, drop your ssh key in to /config/.ssh. Then open a terminal from the top menu and set your github username and email via the following commands
git config --global user.name "username"
+ openvscode-server - LinuxServer.io linuxserver/openvscode-server¶
Openvscode-server provides a version of VS Code that runs a server on a remote machine and allows access through a modern web browser.
Supported Architectures¶
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/openvscode-server:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
Tag Available Description latest ✅ Stable releases insiders ✅ Insiders releases ## Application Setup
If CONNECTION_TOKEN or CONNECTION_SECRET env vars are set, you can access the webui at http://<your-ip>:3000/?tkn=supersecrettoken (replace supersecrettoken with the value set). If not, you can access the webui at http://<your-ip>:3000.
For github integration, drop your ssh key in to /config/.ssh. Then open a terminal from the top menu and set your github username and email via the following commands
When reverse proxied through SWAG, custom services running on specific ports inside openvscode-server can be accessed at https://PORT.openvscode-server.domain.com very much like how code-server's port proxy function is handled. For that, a wildcard CNAME *.openvscode-server.domain.com needs to be created and the SWAG cert needs to cover those subdomains.
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)¶
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 3000Web UI port.
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. CONNECTION_TOKEN=Optional security token for accessing the Web UI (ie. supersecrettoken). CONNECTION_SECRET=Optional path to a file inside the container that contains the security token for accessing the Web UI (ie. /path/to/file). Overrides CONNECTION_TOKEN. SUDO_PASSWORD=passwordIf this optional variable is set, user will have sudo access in the openvscode-server terminal with the specified password. SUDO_PASSWORD_HASH=Optionally set sudo password via hash (takes priority over SUDO_PASSWORD var). Format is $type$salt$hashed.
Volume Mappings (-v)¶
Volume Function /configContains all relevant configuration files.
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:
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:
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 openvscode-server /bin/bash- To monitor the logs of the container in realtime:
docker logs -f openvscode-server- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' openvscode-server- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/openvscode-server:latest
Versions¶
- 01.07.23: - Deprecate armhf. As announced here
- 29.09.22: - Rebase to jammy, switch to s6v3. Fix chown logic to skip
/config/workspace contents. - 12.02.22: - Update
install-extension helper to compensate for upstream changes. - 04.02.22: - Update binary for 1.64.0+. Allow for no token set when both toekn env vars are unset. Add libsecret for keytar.
- 29.12.21: - Add
install-extension as a helper for mods to install extensions. - 10.12.21: - Update deprecated connectionToken arg.
- 30.11.21: - Fix app folder permissions, add the optional sudo password vars.
- 29.11.21: - Create
.profile and .bashrc for the user. - 29.11.21: - Release
insiders tag. - 28.11.21: - Initial Release.
\ No newline at end of file
+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 openvscode-server /bin/bash- To monitor the logs of the container in realtime:
docker logs -f openvscode-server- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' openvscode-server- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/openvscode-server:latest
Versions¶
- 01.07.23: - Deprecate armhf. As announced here
- 29.09.22: - Rebase to jammy, switch to s6v3. Fix chown logic to skip
/config/workspacecontents. - 12.02.22: - Update
install-extensionhelper to compensate for upstream changes. - 04.02.22: - Update binary for 1.64.0+. Allow for no token set when both toekn env vars are unset. Add libsecret for keytar.
- 29.12.21: - Add
install-extensionas a helper for mods to install extensions. - 10.12.21: - Update deprecated connectionToken arg.
- 30.11.21: - Fix app folder permissions, add the optional sudo password vars.
- 29.11.21: - Create
.profileand.bashrcfor the user. - 29.11.21: - Release
insiderstag. - 28.11.21: - Initial Release.
linuxserver/opera¶
Opera is a multi-platform web browser developed by its namesake company Opera. The browser is based on Chromium, but distinguishes itself from other Chromium-based browsers (Chrome, Edge, etc.) through its user interface and other features.
Supported Architectures¶
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/opera:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ❌ | |
| armhf | ❌ |
Application Setup¶
The application can be accessed at:
- http://yourhost:3000/
- https://yourhost:3001/
Options in all KasmVNC based GUI containers¶
This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.
Optional environment variables¶
| Variable | Description |
|---|---|
| CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default 3000. |
| CUSTOM_HTTPS_PORT | Internal port the container listens on for https if it needs to be swapped from the default 3001. |
| CUSTOM_USER | HTTP Basic auth username, abc is default. |
| PASSWORD | HTTP Basic auth password, abc is default. If unset there will be no auth |
| SUBFOLDER | Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/ |
| TITLE | The page title displayed on the web browser, default "KasmVNC Client". |
| FM_HOME | This is the home directory (landing) for the file manager, default "/config". |
| START_DOCKER | If set to false a container with privilege will not automatically start the DinD Docker setup. |
| DRINODE | If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE /dev/dri/renderD128 |
Optional run configurations¶
| Variable | Description |
|---|---|
--privileged | Will start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE -v /home/user/docker-data:/var/lib/docker. |
-v /var/run/docker.sock:/var/run/docker.sock | Mount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. |
--device /dev/dri:/dev/dri | Mount a GPU into the container, this can be used in conjunction with the DRINODE environment variable to leverage a host video card for GPU accelerated appplications. Only Open Source drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau) |
Lossless mode¶
This container is capable of delivering a true lossless image at a high framerate to your web browser by changing the Stream Quality preset to "Lossless", more information here. In order to use this mode from a non localhost endpoint the HTTPS port on 3001 needs to be used. If using a reverse proxy to port 3000 specific headers will need to be set as outlined here.
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)¶
---
+ opera - LinuxServer.io linuxserver/opera¶
Opera is a multi-platform web browser developed by its namesake company Opera. The browser is based on Chromium, but distinguishes itself from other Chromium-based browsers (Chrome, Edge, etc.) through its user interface and other features.
Supported Architectures¶
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/opera:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ❌ armhf ❌
Application Setup¶
The application can be accessed at:
- http://yourhost:3000/
- https://yourhost:3001/
Options in all KasmVNC based GUI containers¶
This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.
Optional environment variables¶
Variable Description CUSTOM_PORT Internal port the container listens on for http if it needs to be swapped from the default 3000. CUSTOM_HTTPS_PORT Internal port the container listens on for https if it needs to be swapped from the default 3001. CUSTOM_USER HTTP Basic auth username, abc is default. PASSWORD HTTP Basic auth password, abc is default. If unset there will be no auth SUBFOLDER Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/ TITLE The page title displayed on the web browser, default "KasmVNC Client". FM_HOME This is the home directory (landing) for the file manager, default "/config". START_DOCKER If set to false a container with privilege will not automatically start the DinD Docker setup. DRINODE If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE /dev/dri/renderD128
Optional run configurations¶
Variable Description --privilegedWill start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE -v /home/user/docker-data:/var/lib/docker. -v /var/run/docker.sock:/var/run/docker.sockMount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. --device /dev/dri:/dev/driMount a GPU into the container, this can be used in conjunction with the DRINODE environment variable to leverage a host video card for GPU accelerated appplications. Only Open Source drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau)
Lossless mode¶
This container is capable of delivering a true lossless image at a high framerate to your web browser by changing the Stream Quality preset to "Lossless", more information here. In order to use this mode from a non localhost endpoint the HTTPS port on 3001 needs to be used. If using a reverse proxy to port 3000 specific headers will need to be set as outlined here.
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)¶
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 3000Opera desktop gui. 3001HTTPS Opera desktop gui.
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. OPERA_CLI=https://www.linuxserver.io/Specify one or multiple Chromium CLI flags, this string will be passed to the application in full.
Volume Mappings (-v)¶
Volume Function /configUsers home directory in the container, stores local files and settings
Miscellaneous Options¶
Parameter Function --shm-size=This is required for Opera to launch and function. --security-opt seccomp=unconfinedFor Docker Engine only, many modern gui apps need this to function on older hosts as syscalls are unknown to Docker. Opera runs in no-sandbox mode without it.
Environment variables from files (Docker secrets)¶
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
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:
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 opera /bin/bash- To monitor the logs of the container in realtime:
docker logs -f opera- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' opera- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/opera:latest
Versions¶
- 09.04.23: - Initial release.
\ No newline at end of file
+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 opera /bin/bash- To monitor the logs of the container in realtime:
docker logs -f opera- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' opera- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/opera:latest
Versions¶
- 09.04.23: - Initial release.
DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. Please use the official image at https://hub.docker.com/r/organizr/organizr
linuxserver/organizr¶
Organizr is a HTPC/Homelab Services Organizer - Written in PHP
Do you have quite a bit of services running on your computer or server? Do you have a lot of bookmarks or have to memorize a bunch of ip's and ports? Well, Organizr is here to help with that. Organizr allows you to setup "Tabs" that will be loaded all in one webpage. You can then work on your server with ease. You can even open up two tabs side by side. Want to give users access to some Tabs? No problem, just enable user support and have them make an account. Want guests to be able to visit too? Enable Guest support for those tabs.
For more information on Organizr and information on how to use it visit their site at https://github.com/causefx/Organizr
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 linuxserver/organizr 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 | amd64-latest |
| arm64 | arm64v8-latest |
| armhf | arm32v7-latest |
Usage¶
Here are some example snippets to help you get started creating a container from this image.
docker-compose (recommended)¶
Compatible with docker-compose v2 schemas.
---
+ organizr - LinuxServer.io DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. Please use the official image at https://hub.docker.com/r/organizr/organizr
linuxserver/organizr¶
Organizr is a HTPC/Homelab Services Organizer - Written in PHP
Do you have quite a bit of services running on your computer or server? Do you have a lot of bookmarks or have to memorize a bunch of ip's and ports? Well, Organizr is here to help with that. Organizr allows you to setup "Tabs" that will be loaded all in one webpage. You can then work on your server with ease. You can even open up two tabs side by side. Want to give users access to some Tabs? No problem, just enable user support and have them make an account. Want guests to be able to visit too? Enable Guest support for those tabs.
For more information on Organizr and information on how to use it visit their site at https://github.com/causefx/Organizr
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 linuxserver/organizr 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 amd64-latest arm64 arm64v8-latest armhf arm32v7-latest
Usage¶
Here are some example snippets to help you get started creating a container from this image.
docker-compose (recommended)¶
Compatible with docker-compose v2 schemas.
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 80will map the container's port 80 to port 9983 on the host
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=<your timezone, eg Europe/London>for specifying your timezone
Volume Mappings (-v)¶
Volume Function /configthis is where your user data and logs will live
Environment variables from files (Docker secrets)¶
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
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:
Application Setup¶
Dead simple to get running, create the container as instructed and start it. When up and running, load the site.
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 organizr /bin/bash- To monitor the logs of the container in realtime:
docker logs -f organizr- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' organizr- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/organizr
Versions¶
- 18.04.19: - Fix new install not working.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 26.02.19: - Upgrade packages during install to prevent mismatch with baseimage.
- 22.02.19: - Rebasing to alpine 3.9.
- 11.02.19: - Fix permissions on new app location
- 31.12.18: - Moved to pipeline building from v1-master branch
- 05.09.18: - Rebase to Alpine 3.8
- 10.01.18: - Rebase to Alpine 3.7
- 25.05.17: - Rebase to Alpine 3.6
- 02.05.17: - Added php7-curl package
- 12.04.17: - Added php7-ldap package
- 10.03.18: - Initial Release.
\ No newline at end of file
+Application Setup¶
Dead simple to get running, create the container as instructed and start it. When up and running, load the site.
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 organizr /bin/bash- To monitor the logs of the container in realtime:
docker logs -f organizr- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' organizr- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/organizr
Versions¶
- 18.04.19: - Fix new install not working.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 26.02.19: - Upgrade packages during install to prevent mismatch with baseimage.
- 22.02.19: - Rebasing to alpine 3.9.
- 11.02.19: - Fix permissions on new app location
- 31.12.18: - Moved to pipeline building from v1-master branch
- 05.09.18: - Rebase to Alpine 3.8
- 10.01.18: - Rebase to Alpine 3.7
- 25.05.17: - Rebase to Alpine 3.6
- 02.05.17: - Added php7-curl package
- 12.04.17: - Added php7-ldap package
- 10.03.18: - Initial Release.
linuxserver/oscam¶
Oscam is an Open Source Conditional Access Module software used for descrambling DVB transmissions using smart cards. It's both a server and a client.
Supported Architectures¶
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/oscam:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
To set up oscam there are numerous guides on the internet. There are too many scenarios to make a quick guide. The web interface is at port 8888. You can find the project wiki here.
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)¶
---
+ oscam - LinuxServer.io linuxserver/oscam¶
Oscam is an Open Source Conditional Access Module software used for descrambling DVB transmissions using smart cards. It's both a server and a client.
Supported Architectures¶
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/oscam:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
To set up oscam there are numerous guides on the internet. There are too many scenarios to make a quick guide. The web interface is at port 8888. You can find the project wiki here.
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)¶
Passing through Smart Card Readers¶
If you want to pass through a smart card reader, you need to specify the reader with the --device= tag. The method used depends on how the reader is recognized. The first is /dev/ttyUSBX. To find the correct device, connect the reader and run dmesg | tail on the host. In the output you will find /dev/ttyUSBX, where X is the number of the device. If this is the first reader you connect to your host, it will be /dev/ttyUSB0. If you add one more it will be /dev/ttyUSB1.
If there are no /dev/ttyUSBX device in dmesg | tail, you have to use the USB bus path. It will look similar to the below.
/dev/bus/usb/001/001
The important parts are the two numbers in the end. The first one is the Bus number, the second is the Device number. To find the Bus and Device number you have to run lsusb on the host, then find your USB device in the list and note the Bus and Device numbers.
Here is an example of how to find the Bus and Device. The output of the lsusb command is below.
Bus 002 Device 005: ID 076b:6622 OmniKey AG CardMan 6121
The first number, the Bus, is 002. The second number, the Device, is 005. This will look like below in the --device= tag.
--device=/dev/bus/usb/002/005
If you have multiple smart card readers, you add one --device= tag for each reader.
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 8888WebUI
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configWhere oscam should store config files and logs.
Device Mappings (--device)¶
Parameter Function /dev/ttyUSB0For passing through smart card readers.
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:
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:
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 oscam /bin/bash- To monitor the logs of the container in realtime:
docker logs -f oscam- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' oscam- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/oscam:latest
Versions¶
- 27.08.23: - Rebase to Alpine 3.18. Pull PCSC driver from Linuxserver S3 due to Cloudflare blocking curl download of original file.
- 07.07.23: - Deprecate armhf. As announced here
- 13.03.23: - Rebase to Alpine 3.17.
- 03.11.22: - Rebasing to alpine 3.16 and s6v3. Update pcsd driver link.
- 13.02.22: - Rebasing to alpine 3.15.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 29.04.19: - Add revision check, so pipeline can build new revisions.
- 28.04.19: - Switch back to streamboard svn to fix version not showing in UI.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 19.02.19: - Add pipeline logic and multi arch, rebase to Alpine 3.8.
- 03.01.18: - Deprecate cpu_core routine lack of scaling.
- 13.12.17: - Rebase to alpine 3.7.
- 19.10.17: - Add ccid package for usb card readers.
- 17.10.17: - Switch to using bzr for source code, streamboard awol.
- 28.05.17: - Rebase to alpine 3.6.
- 09.02.17: - Rebase to alpine 3.5.
- 14.10.16: - Add version layer information.
- 02.10.16: - Add info on passing through devices to README.
- 25.09.16: - Initial release.
\ No newline at end of file
+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 oscam /bin/bash- To monitor the logs of the container in realtime:
docker logs -f oscam- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' oscam- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/oscam:latest
Versions¶
- 27.08.23: - Rebase to Alpine 3.18. Pull PCSC driver from Linuxserver S3 due to Cloudflare blocking curl download of original file.
- 07.07.23: - Deprecate armhf. As announced here
- 13.03.23: - Rebase to Alpine 3.17.
- 03.11.22: - Rebasing to alpine 3.16 and s6v3. Update pcsd driver link.
- 13.02.22: - Rebasing to alpine 3.15.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 29.04.19: - Add revision check, so pipeline can build new revisions.
- 28.04.19: - Switch back to streamboard svn to fix version not showing in UI.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 19.02.19: - Add pipeline logic and multi arch, rebase to Alpine 3.8.
- 03.01.18: - Deprecate cpu_core routine lack of scaling.
- 13.12.17: - Rebase to alpine 3.7.
- 19.10.17: - Add ccid package for usb card readers.
- 17.10.17: - Switch to using bzr for source code, streamboard awol.
- 28.05.17: - Rebase to alpine 3.6.
- 09.02.17: - Rebase to alpine 3.5.
- 14.10.16: - Add version layer information.
- 02.10.16: - Add info on passing through devices to README.
- 25.09.16: - Initial release.
linuxserver/overseerr¶
Overseerr is a request management and media discovery tool built to work with your existing Plex ecosystem.
Supported Architectures¶
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/overseerr:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
| Tag | Available | Description |
|---|---|---|
| latest | ✅ | Stable releases from GitHub |
| develop | ✅ | Development releases from commits in upstream develop branch |
| ## Application Setup |
Access the webui at <your-ip>:5055, for more information check out Overseerr.
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)¶
---
+ overseerr - LinuxServer.io linuxserver/overseerr¶
Overseerr is a request management and media discovery tool built to work with your existing Plex ecosystem.
Supported Architectures¶
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/overseerr:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
Tag Available Description latest ✅ Stable releases from GitHub develop ✅ Development releases from commits in upstream develop branch ## Application Setup
Access the webui at <your-ip>:5055, for more information check out Overseerr.
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)¶
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 5055Port for Overseerr's web interface.
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configContains all relevant configuration files.
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:
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:
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 overseerr /bin/bash- To monitor the logs of the container in realtime:
docker logs -f overseerr- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' overseerr- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/overseerr:latest
Versions¶
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 18.12.22: - Rebase main to 3.17.
- 27.10.22: - Rebase main to 3.16, migrate to s6v3.
- 20.08.22: - Don't install cypress.
- 01.04.22: - Rebase main branch to Alpine 3.15.
- 27.01.22: - Rebase develop branch to Alpine 3.15.
- 04.01.22: - Remove cached files.
- 10.10.21: - Add additional post-build cleanup.
- 19.09.21: - Rebase to alpine 3.14. Update code formatting. Increase js mem limit.
- 05.04.21: - Initial Release.
\ No newline at end of file
+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 overseerr /bin/bash- To monitor the logs of the container in realtime:
docker logs -f overseerr- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' overseerr- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/overseerr:latest
Versions¶
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 18.12.22: - Rebase main to 3.17.
- 27.10.22: - Rebase main to 3.16, migrate to s6v3.
- 20.08.22: - Don't install cypress.
- 01.04.22: - Rebase main branch to Alpine 3.15.
- 27.01.22: - Rebase develop branch to Alpine 3.15.
- 04.01.22: - Remove cached files.
- 10.10.21: - Add additional post-build cleanup.
- 19.09.21: - Rebase to alpine 3.14. Update code formatting. Increase js mem limit.
- 05.04.21: - Initial Release.
linuxserver/pairdrop¶
PairDrop is a sublime alternative to AirDrop that works on all platforms. Send images, documents or text via peer to peer connection to devices in the same local network/Wi-Fi or to paired devices.
Supported Architectures¶
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/pairdrop:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
Web UI is accessible at http://SERVERIP:PORT. It is strongly recommended to run PairDrop via a reverse proxy, served over HTTPS, if you are making it publicly available. In this configuration you must ensure that the X-Forwarded-For header is being set correctly, otherwise all clients will be mutually visible.
Most proxies will set this header automatically but may require additional configuration if you are using something like Cloudflare Proxy.
Custom STUN/TURN Servers¶
To specify custom STUN/TURN servers for PairDrop clients to use, create a JSON config file in a mounted path and use the RTC_CONFIG environment variable to point to it.
You can use https://raw.githubusercontent.com/schlagmichdoch/PairDrop/master/rtc_config_example.json as a starting point.
Note on Websocket fallback¶
Enabling WS_FALLBACK provides a fallback if the peer to peer WebRTC connection is not available to the client.
This is especially useful if you connect to your instance via a VPN as most VPN services block WebRTC completely in order to hide your real IP address.
Warning: All traffic sent between devices using this fallback is routed through the server and therefor not peer to peer! Traffic routed via this fallback is readable by the server and uses the server's bandwidth.
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)¶
---
+ pairdrop - LinuxServer.io linuxserver/pairdrop¶
PairDrop is a sublime alternative to AirDrop that works on all platforms. Send images, documents or text via peer to peer connection to devices in the same local network/Wi-Fi or to paired devices.
Supported Architectures¶
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/pairdrop:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
Web UI is accessible at http://SERVERIP:PORT. It is strongly recommended to run PairDrop via a reverse proxy, served over HTTPS, if you are making it publicly available. In this configuration you must ensure that the X-Forwarded-For header is being set correctly, otherwise all clients will be mutually visible.
Most proxies will set this header automatically but may require additional configuration if you are using something like Cloudflare Proxy.
Custom STUN/TURN Servers¶
To specify custom STUN/TURN servers for PairDrop clients to use, create a JSON config file in a mounted path and use the RTC_CONFIG environment variable to point to it.
You can use https://raw.githubusercontent.com/schlagmichdoch/PairDrop/master/rtc_config_example.json as a starting point.
Note on Websocket fallback¶
Enabling WS_FALLBACK provides a fallback if the peer to peer WebRTC connection is not available to the client.
This is especially useful if you connect to your instance via a VPN as most VPN services block WebRTC completely in order to hide your real IP address.
Warning: All traffic sent between devices using this fallback is routed through the server and therefor not peer to peer! Traffic routed via this fallback is readable by the server and uses the server's bandwidth.
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)¶
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 3000http gui
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. RATE_LIMIT=falseSet to true to limit clients to 100 requests per 5 min WS_FALLBACK=falseSet to true to enable websocket fallback if the peer to peer WebRTC connection is not available to the client (see App Setup notes). RTC_CONFIG=Path to a json file containing custom STUN/TURN config (see App Setup notes) DEBUG_MODE=falseSet to true to debug the http server configuration by logging clients IP addresses used by PairDrop to STDOUT. See here for more info. Do not use in production!
Volume Mappings (-v)¶
Volume Function
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:
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:
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 pairdrop /bin/bash- To monitor the logs of the container in realtime:
docker logs -f pairdrop- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' pairdrop- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/pairdrop:latest
Versions¶
- 30.05.23: - Rebase to Alpine 3.18.
- 06.03.23: - Run npm install as non-root user.
- 20.02.23: - Initial Release.
\ No newline at end of file
+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 pairdrop /bin/bash- To monitor the logs of the container in realtime:
docker logs -f pairdrop- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' pairdrop- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/pairdrop:latest
Versions¶
- 30.05.23: - Rebase to Alpine 3.18.
- 06.03.23: - Run npm install as non-root user.
- 20.02.23: - Initial Release.
DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. We recommend switching to the new official container: https://github.com/paperless-ngx/paperless-ngx
linuxserver/paperless-ng¶
Paperless-ng is an application by Daniel Quinn and contributors that indexes your scanned documents and allows you to easily search for documents and store metadata alongside your documents."
Supported Architectures¶
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/paperless-ng:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ✅ | arm32v7-<version tag> |
Application Setup¶
Default login is admin:admin via the webui, accessible at http://SERVERIP:PORT More info at paperless-ng. For convenience this container provides an alias to perform administration management commands. Available administration commands are documented upstream here and can be accessed with this container thus: docker exec -it <container_name> manage <command>. For example, docker exec -it paperless manage document_retagger -tT.
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)¶
---
+ paperless-ng - LinuxServer.io DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. We recommend switching to the new official container: https://github.com/paperless-ngx/paperless-ngx
linuxserver/paperless-ng¶
Paperless-ng is an application by Daniel Quinn and contributors that indexes your scanned documents and allows you to easily search for documents and store metadata alongside your documents."
Supported Architectures¶
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/paperless-ng:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ✅ arm32v7-<version tag>
Application Setup¶
Default login is admin:admin via the webui, accessible at http://SERVERIP:PORT More info at paperless-ng. For convenience this container provides an alias to perform administration management commands. Available administration commands are documented upstream here and can be accessed with this container thus: docker exec -it <container_name> manage <command>. For example, docker exec -it paperless manage document_retagger -tT.
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)¶
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 8000http gui
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=America/New_YorkSpecify a timezone to use EG America/New_York REDIS_URL=Specify an external redis instance to use. Can optionally include a port (redis:6379) and/or db (redis/foo). If left blank or not included, will use a built-in redis instance. If changed after initial setup will also require manual modification of /config/settings.py
Volume Mappings (-v)¶
Volume Function /configContains all relevant configuration files. /dataStorage location for all paperless-ng data files.
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:
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:
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 paperless-ng /bin/bash- To monitor the logs of the container in realtime:
docker logs -f paperless-ng- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' paperless-ng- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/paperless-ng:latest
Versions¶
- 05.09.22: - Deprecate.
- 30.11.21: - Added in jbig2enc.
- 07.10.21: - Fixed variable that determins if we should run redis locally.
- 01.10.21: - Replaced uwsgi with gunicorn due to websocket issues.
- 24.07.21: - Fixed directory config files (sqlite db) is all stored.
- 23.07.21: - Fixed initial user creation.
- 10.07.21: - Initial Release.
\ No newline at end of file
+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 paperless-ng /bin/bash- To monitor the logs of the container in realtime:
docker logs -f paperless-ng- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' paperless-ng- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/paperless-ng:latest
Versions¶
- 05.09.22: - Deprecate.
- 30.11.21: - Added in jbig2enc.
- 07.10.21: - Fixed variable that determins if we should run redis locally.
- 01.10.21: - Replaced uwsgi with gunicorn due to websocket issues.
- 24.07.21: - Fixed directory config files (sqlite db) is all stored.
- 23.07.21: - Fixed initial user creation.
- 10.07.21: - Initial Release.
DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. We recommend switching to the new official container: https://github.com/paperless-ngx/paperless-ngx
linuxserver/paperless-ngx¶
Paperless-ngx is an application by Daniel Quinn and contributors that indexes your scanned documents and allows you to easily search for documents and store metadata alongside your documents."
Supported Architectures¶
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/paperless-ngx:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ✅ | arm32v7-<version tag> |
Application Setup¶
Default login is admin:admin via the webui, accessible at http://SERVERIP:PORT More info at paperless-ngx. For convenience this container provides an alias to perform administration management commands. Available administration commands are documented upstream here and can be accessed with this container thus: docker exec -it <container_name> manage <command>. For example, docker exec -it paperless manage document_retagger -tT.
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)¶
---
+ paperless-ngx - LinuxServer.io DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. We recommend switching to the new official container: https://github.com/paperless-ngx/paperless-ngx
linuxserver/paperless-ngx¶
Paperless-ngx is an application by Daniel Quinn and contributors that indexes your scanned documents and allows you to easily search for documents and store metadata alongside your documents."
Supported Architectures¶
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/paperless-ngx:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ✅ arm32v7-<version tag>
Application Setup¶
Default login is admin:admin via the webui, accessible at http://SERVERIP:PORT More info at paperless-ngx. For convenience this container provides an alias to perform administration management commands. Available administration commands are documented upstream here and can be accessed with this container thus: docker exec -it <container_name> manage <command>. For example, docker exec -it paperless manage document_retagger -tT.
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)¶
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 8000http gui
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=America/New_YorkSpecify a timezone to use EG America/New_York REDIS_URL=Specify an external redis instance to use. Can optionally include a port (redis:6379) and/or db (redis/foo). If left blank or not included, will use a built-in redis instance. If changed after initial setup will also require manual modification of /config/settings.py
Volume Mappings (-v)¶
Volume Function /configContains all relevant configuration files. /dataStorage location for all paperless-ngx data files.
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:
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:
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 paperless-ngx /bin/bash- To monitor the logs of the container in realtime:
docker logs -f paperless-ngx- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' paperless-ngx- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/paperless-ngx:latest
Versions¶
- 05.09.22: - Deprecate.
- 16.05.22: - Add correct libqpdf.so to arm builds.
- 14.05.22: - Fine tune disabling of redis.
- 12.05.22: - Move migrations to after multilangocr mod. Fix disabling of redis. Add missing dep for postgresql.
- 12.05.22: - Utilize lsio wheel for pikepdf.
- 11.05.22: - Update upstream artifact name and utilize lsio wheels for scipy and scikit-learn.
- 05.05.22: - Add runtime dependencies libxslt1.1 for armhf
- 30.04.22: - Add runtime dependencies lizbar and poppler-utils
- 27.04.22: - Add build-dependencies for arm32 builds.
- 11.04.22: - Replaced uwsgi with gunicorn due to websocket issues.
- 11.03.22: - Initial Release.
\ No newline at end of file
+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 paperless-ngx /bin/bash- To monitor the logs of the container in realtime:
docker logs -f paperless-ngx- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' paperless-ngx- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/paperless-ngx:latest
Versions¶
- 05.09.22: - Deprecate.
- 16.05.22: - Add correct libqpdf.so to arm builds.
- 14.05.22: - Fine tune disabling of redis.
- 12.05.22: - Move migrations to after multilangocr mod. Fix disabling of redis. Add missing dep for postgresql.
- 12.05.22: - Utilize lsio wheel for pikepdf.
- 11.05.22: - Update upstream artifact name and utilize lsio wheels for scipy and scikit-learn.
- 05.05.22: - Add runtime dependencies libxslt1.1 for armhf
- 30.04.22: - Add runtime dependencies lizbar and poppler-utils
- 27.04.22: - Add build-dependencies for arm32 builds.
- 11.04.22: - Replaced uwsgi with gunicorn due to websocket issues.
- 11.03.22: - Initial Release.
DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. The last working tag is: v2.0.1-ls60 We recommend the official image instead: https://hub.docker.com/r/papermerge/papermerge
linuxserver/papermerge¶
Papermerge is an open source document management system (DMS) primarily designed for archiving and retrieving your digital documents. Instead of having piles of paper documents all over your desk, office or drawers - you can quickly scan them and configure your scanner to directly upload to Papermerge DMS."
Supported Architectures¶
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/papermerge:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ✅ | arm32v7-<version tag> |
Application Setup¶
Default login is admin:admin via the webui, accessible at http://SERVERIP:PORT More info at papermerge.
If you need non-English OCR language support, you can use this mod.
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)¶
---
+ papermerge - LinuxServer.io DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. The last working tag is: v2.0.1-ls60 We recommend the official image instead: https://hub.docker.com/r/papermerge/papermerge
linuxserver/papermerge¶
Papermerge is an open source document management system (DMS) primarily designed for archiving and retrieving your digital documents. Instead of having piles of paper documents all over your desk, office or drawers - you can quickly scan them and configure your scanner to directly upload to Papermerge DMS."
Supported Architectures¶
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/papermerge:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ✅ arm32v7-<version tag>
Application Setup¶
Default login is admin:admin via the webui, accessible at http://SERVERIP:PORT More info at papermerge.
If you need non-English OCR language support, you can use this mod.
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)¶
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 8000http gui
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. REDIS_URL=Specify an external redis instance to use. Can optionally include a port (redis:6379) and/or db (redis/foo). If left blank or not included, will use a built-in redis instance. If changed after initial setup will also require manual modification of /config/settings.py
Volume Mappings (-v)¶
Volume Function /configContains all relevant configuration files. /dataStorage location for all papermerge data files.
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:
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:
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 papermerge /bin/bash- To monitor the logs of the container in realtime:
docker logs -f papermerge- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' papermerge- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/papermerge:latest
Versions¶
- 15.02.23: - Deprecate image.
- 15.07.22: - Don't install development python packages
- 13.04.21: - Handle upstream stapler change
- 13.03.21: - Fixed mglib dependency per issue 32
- 25.02.21: - Updated dependencies for v2
- 07.02.21: - Support external MySQL/PSQL DBs.
- 01.02.21: - Add redis.
- 09.12.20: - Fix locales.
- 08.08.20: - Initial Release.
\ No newline at end of file
+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 papermerge /bin/bash- To monitor the logs of the container in realtime:
docker logs -f papermerge- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' papermerge- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/papermerge:latest
Versions¶
- 15.02.23: - Deprecate image.
- 15.07.22: - Don't install development python packages
- 13.04.21: - Handle upstream stapler change
- 13.03.21: - Fixed mglib dependency per issue 32
- 25.02.21: - Updated dependencies for v2
- 07.02.21: - Support external MySQL/PSQL DBs.
- 01.02.21: - Add redis.
- 09.12.20: - Fix locales.
- 08.08.20: - Initial Release.
DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated.
linuxserver/photoshow¶
Photoshow is gallery software at its easiest, it doesn't even require a database.
Supported Architectures¶
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/photoshow:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ✅ | arm32v7-<version tag> |
Application Setup¶
On first run create an admin account, any folder and its subfolders that you map to /Pictures will be presented as a webgallery. Config settings are persistent and stored as a subfolder of the /Thumbs mapping.
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)¶
---
+ photoshow - LinuxServer.io DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated.
linuxserver/photoshow¶
Photoshow is gallery software at its easiest, it doesn't even require a database.
Supported Architectures¶
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/photoshow:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ✅ arm32v7-<version tag>
Application Setup¶
On first run create an admin account, any folder and its subfolders that you map to /Pictures will be presented as a webgallery. Config settings are persistent and stored as a subfolder of the /Thumbs mapping.
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)¶
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 80WebUI
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Europe/LondonSpecify a timezone to use EG Europe/London.
Volume Mappings (-v)¶
Volume Function /configStores config and logs for nginx base. /Pictures:roYour local folder of photos you wish to share. /ThumbsLocal folder to store thumbnails of your images.
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:
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:
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 photoshow /bin/bash- To monitor the logs of the container in realtime:
docker logs -f photoshow- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' photoshow- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/photoshow:latest
Versions¶
- 14.10.22: - Deprecate image.
- 23.01.21: - Rebasing to alpine 3.13.
- 01.06.20: - Rebasing to alpine 3.12.
- 19.12.19: - Rebasing to alpine 3.11.
- 23.09.19: - Adding PHP-Exif for image metadata and processing.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebasing to alpine 3.9.
- 16.01.19: - Add pipeline logic and multi arch.
- 05.09.18: - Rebase to alpine 3.8.
- 07.01.18: - Rebase to alpine 3.7.
- 25.05.17: - Rebase to alpine 3.6.
- 03.05.17: - Use repo pinning to better solve dependencies, use repo version of php7-imagick.
- 14.02.17: - Rebase to alpine 3.5.
- 14.10.16: - Add version layer information.
- 30.09.16: - Rebase to alpine linux.
- 11.09.16: - Add layer badges to README.
- 21.08.15: - Use patched keybaord js from fork of photoshow.
- 21.08.15: - Initial Release.
\ No newline at end of file
+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 photoshow /bin/bash- To monitor the logs of the container in realtime:
docker logs -f photoshow- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' photoshow- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/photoshow:latest
Versions¶
- 14.10.22: - Deprecate image.
- 23.01.21: - Rebasing to alpine 3.13.
- 01.06.20: - Rebasing to alpine 3.12.
- 19.12.19: - Rebasing to alpine 3.11.
- 23.09.19: - Adding PHP-Exif for image metadata and processing.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebasing to alpine 3.9.
- 16.01.19: - Add pipeline logic and multi arch.
- 05.09.18: - Rebase to alpine 3.8.
- 07.01.18: - Rebase to alpine 3.7.
- 25.05.17: - Rebase to alpine 3.6.
- 03.05.17: - Use repo pinning to better solve dependencies, use repo version of php7-imagick.
- 14.02.17: - Rebase to alpine 3.5.
- 14.10.16: - Add version layer information.
- 30.09.16: - Rebase to alpine linux.
- 11.09.16: - Add layer badges to README.
- 21.08.15: - Use patched keybaord js from fork of photoshow.
- 21.08.15: - Initial Release.
linuxserver/phpmyadmin¶
Phpmyadmin is a free software tool written in PHP, intended to handle the administration of MySQL over the Web. phpMyAdmin supports a wide range of operations on MySQL and MariaDB.
Supported Architectures¶
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/phpmyadmin:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
This image uses nginx, in contrast to the official images which offer fpm-only or Apache variants.
We support all of the official environment variables for configuration as well as directly editing the config files.
For more information check out the phpmyadmin documentation.
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)¶
---
+ phpmyadmin - LinuxServer.io linuxserver/phpmyadmin¶
Phpmyadmin is a free software tool written in PHP, intended to handle the administration of MySQL over the Web. phpMyAdmin supports a wide range of operations on MySQL and MariaDB.
Supported Architectures¶
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/phpmyadmin:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
This image uses nginx, in contrast to the official images which offer fpm-only or Apache variants.
We support all of the official environment variables for configuration as well as directly editing the config files.
For more information check out the phpmyadmin documentation.
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)¶
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 80Port for web frontend
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. PMA_ARBITRARY=1Set to 1 to allow you to connect to any server. Setting to 0 will only allow you to connect to specified hosts (See Application Setup) PMA_ABSOLUTE_URI=https://phpmyadmin.example.comSet the URL you will use to access the web frontend
Volume Mappings (-v)¶
Volume Function /configContains all relevant configuration files.
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:
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:
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 phpmyadmin /bin/bash- To monitor the logs of the container in realtime:
docker logs -f phpmyadmin- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' phpmyadmin- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/phpmyadmin:latest
Versions¶
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 13.04.23: - Move ssl.conf include to default.conf.
- 20.01.23: - Rebase to alpine 3.17 with php8.1.
- 18.11.22: - Rebasing to Alpine 3.16, migrate to s6v3.
- 20.08.22: - Rebasing to Alpine 3.15 with php8. Restructure nginx configs (see changes announcement).
- 23.01.22: - Pin versions to 5.x.x.
- 14.06.21: - Initial Release.
\ No newline at end of file
+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 phpmyadmin /bin/bash- To monitor the logs of the container in realtime:
docker logs -f phpmyadmin- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' phpmyadmin- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/phpmyadmin:latest
Versions¶
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 13.04.23: - Move ssl.conf include to default.conf.
- 20.01.23: - Rebase to alpine 3.17 with php8.1.
- 18.11.22: - Rebasing to Alpine 3.16, migrate to s6v3.
- 20.08.22: - Rebasing to Alpine 3.15 with php8. Restructure nginx configs (see changes announcement).
- 23.01.22: - Pin versions to 5.x.x.
- 14.06.21: - Initial Release.
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¶
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:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
The application can be accessed at:
- http://yourhost:3000/
- 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.
- 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
Options in all KasmVNC based GUI containers¶
This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.
Optional environment variables¶
| Variable | Description |
|---|---|
| CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default 3000. |
| CUSTOM_HTTPS_PORT | Internal port the container listens on for https if it needs to be swapped from the default 3001. |
| CUSTOM_USER | HTTP Basic auth username, abc is default. |
| PASSWORD | HTTP Basic auth password, abc is default. If unset there will be no auth |
| SUBFOLDER | Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/ |
| TITLE | The page title displayed on the web browser, default "KasmVNC Client". |
| FM_HOME | This is the home directory (landing) for the file manager, default "/config". |
| START_DOCKER | If set to false a container with privilege will not automatically start the DinD Docker setup. |
| DRINODE | If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE /dev/dri/renderD128 |
Optional run configurations¶
| Variable | Description |
|---|---|
--privileged | Will start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE -v /home/user/docker-data:/var/lib/docker. |
-v /var/run/docker.sock:/var/run/docker.sock | Mount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. |
--device /dev/dri:/dev/dri | Mount a GPU into the container, this can be used in conjunction with the DRINODE environment variable to leverage a host video card for GPU accelerated appplications. Only Open Source drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau) |
Lossless mode¶
This container is capable of delivering a true lossless image at a high framerate to your web browser by changing the Stream Quality preset to "Lossless", more information here. In order to use this mode from a non localhost endpoint the HTTPS port on 3001 needs to be used. If using a reverse proxy to port 3000 specific headers will need to be set as outlined here.
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)¶
---
+ pidgin - LinuxServer.io 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¶
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:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
The application can be accessed at:
- http://yourhost:3000/
- 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.
- 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
Options in all KasmVNC based GUI containers¶
This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.
Optional environment variables¶
Variable Description CUSTOM_PORT Internal port the container listens on for http if it needs to be swapped from the default 3000. CUSTOM_HTTPS_PORT Internal port the container listens on for https if it needs to be swapped from the default 3001. CUSTOM_USER HTTP Basic auth username, abc is default. PASSWORD HTTP Basic auth password, abc is default. If unset there will be no auth SUBFOLDER Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/ TITLE The page title displayed on the web browser, default "KasmVNC Client". FM_HOME This is the home directory (landing) for the file manager, default "/config". START_DOCKER If set to false a container with privilege will not automatically start the DinD Docker setup. DRINODE If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE /dev/dri/renderD128
Optional run configurations¶
Variable Description --privilegedWill start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE -v /home/user/docker-data:/var/lib/docker. -v /var/run/docker.sock:/var/run/docker.sockMount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. --device /dev/dri:/dev/driMount a GPU into the container, this can be used in conjunction with the DRINODE environment variable to leverage a host video card for GPU accelerated appplications. Only Open Source drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau)
Lossless mode¶
This container is capable of delivering a true lossless image at a high framerate to your web browser by changing the Stream Quality preset to "Lossless", more information here. In order to use this mode from a non localhost endpoint the HTTPS port on 3001 needs to be used. If using a reverse proxy to port 3000 specific headers will need to be set as outlined here.
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)¶
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 3000Pidgin desktop gui. 3001Pidgin desktop gui HTTPS.
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configUsers home directory in the container, stores local files and settings
Miscellaneous Options¶
Parameter Function --security-opt seccomp=unconfinedFor Docker Engine only, many modern gui apps need this to function on older hosts as syscalls are unknown to Docker.
Environment variables from files (Docker secrets)¶
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
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:
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:latest
Versions¶
- 13.05.23: - Rebase to Alpine 3.18.
- 18.03.23: - Rebase to KasmVNC base image.
- 21.10.22: - Rebase to Alpine 3.16, migrate to s6v3.
- 15.02.22: - Add build deps for discord.
- 23.12.21: - Rebase to Alpine 3.15.
- 26.09.21: - Rebase to Alpine 3.14.
- 14.05.21: - Initial release.
\ No newline at end of file
+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:latest
Versions¶
- 13.05.23: - Rebase to Alpine 3.18.
- 18.03.23: - Rebase to KasmVNC base image.
- 21.10.22: - Rebase to Alpine 3.16, migrate to s6v3.
- 15.02.22: - Add build deps for discord.
- 23.12.21: - Rebase to Alpine 3.15.
- 26.09.21: - Rebase to Alpine 3.14.
- 14.05.21: - Initial release.
linuxserver/piwigo¶
Piwigo is a photo gallery software for the web that comes with powerful features to publish and manage your collection of pictures.
Supported Architectures¶
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/piwigo:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
-
You must create a user and database for piwigo to use in a mysql/mariadb server.
-
Self-signed keys are generated the first time you run the container and can be found in
/config/keys, if needed, you can replace them with your own. -
The easiest way to edit the configuration file is to enable local files editor from the plugins page and use it to configure email settings etc."
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)¶
---
+ piwigo - LinuxServer.io linuxserver/piwigo¶
Piwigo is a photo gallery software for the web that comes with powerful features to publish and manage your collection of pictures.
Supported Architectures¶
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/piwigo:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
-
You must create a user and database for piwigo to use in a mysql/mariadb server.
-
Self-signed keys are generated the first time you run the container and can be found in /config/keys, if needed, you can replace them with your own.
-
The easiest way to edit the configuration file is to enable local files editor from the plugins page and use it to configure email settings etc."
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)¶
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 80Application WebUI
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configConfiguration files. /galleryImage storage for Piwigo
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:
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:
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 piwigo /bin/bash- To monitor the logs of the container in realtime:
docker logs -f piwigo- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' piwigo- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/piwigo:latest
Versions¶
- 03.06.23: - Revert to Alpine 3.17 due to compatibility issues with php 8.2.
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 20.01.23: - Rebase to alpine 3.17 with php8.1.
- 16.01.23: - Fix broken custom template persistence.
- 08.11.22: - Rebase to Alpine 3.16, migrate to s6v3. Move application install to /app/www/public, add migration for existing users. Container updates should now update the application correctly.
- 20.08.22: - Rebasing to alpine 3.15 with php8. Restructure nginx configs (see changes announcement).
- 29.06.21: - Rebase to 3.14, Add php7-zip package
- 20.05.21: - Create separate volume for image data
- 23.01.21: - Rebasing to alpine 3.13.
- 12.12.20: - Increased upload_max_filesize in php.ini
- 01.06.20: - Rebasing to alpine 3.12.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 12.06.19: - Add ffmpeg and other deps as needed by popular plugins.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 01.03.19: - Add php-ctype & php-curl.
- 22.02.19: - Rebasing to alpine 3.9, add php-ldap.
- 28.01.19: - Rebase to alpine linux 3.8 , add pipeline logic and multi arch.
- 25.01.18: - Rebase to alpine linux 3.7.
- 25.05.17: - Rebase to alpine linux 3.6.
- 03.05.17: - Use repo pinning to better solve dependencies, use repo version of php7-imagick.
- 20.04.17: - Add php7-exif package, thanks iiska
- 23.02.17: - Rebase to alpine linux 3.5 and nginx.
- 14.10.16: - Add version layer information.
- 10.09.16: - Add layer badges to README.
- 29.08.15: - Initial Release.
\ No newline at end of file
+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 piwigo /bin/bash- To monitor the logs of the container in realtime:
docker logs -f piwigo- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' piwigo- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/piwigo:latest
Versions¶
- 03.06.23: - Revert to Alpine 3.17 due to compatibility issues with php 8.2.
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 20.01.23: - Rebase to alpine 3.17 with php8.1.
- 16.01.23: - Fix broken custom template persistence.
- 08.11.22: - Rebase to Alpine 3.16, migrate to s6v3. Move application install to /app/www/public, add migration for existing users. Container updates should now update the application correctly.
- 20.08.22: - Rebasing to alpine 3.15 with php8. Restructure nginx configs (see changes announcement).
- 29.06.21: - Rebase to 3.14, Add php7-zip package
- 20.05.21: - Create separate volume for image data
- 23.01.21: - Rebasing to alpine 3.13.
- 12.12.20: - Increased upload_max_filesize in php.ini
- 01.06.20: - Rebasing to alpine 3.12.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 12.06.19: - Add ffmpeg and other deps as needed by popular plugins.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 01.03.19: - Add php-ctype & php-curl.
- 22.02.19: - Rebasing to alpine 3.9, add php-ldap.
- 28.01.19: - Rebase to alpine linux 3.8 , add pipeline logic and multi arch.
- 25.01.18: - Rebase to alpine linux 3.7.
- 25.05.17: - Rebase to alpine linux 3.6.
- 03.05.17: - Use repo pinning to better solve dependencies, use repo version of php7-imagick.
- 20.04.17: - Add php7-exif package, thanks iiska
- 23.02.17: - Rebase to alpine linux 3.5 and nginx.
- 14.10.16: - Add version layer information.
- 10.09.16: - Add layer badges to README.
- 29.08.15: - Initial Release.
DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated.
linuxserver/pixapop¶
Pixapop is an open-source single page application to view your photos in the easiest way possible.
Supported Architectures¶
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/pixapop:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ✅ | arm32v7-<version tag> |
Application Setup¶
Any photos included in /photos will be presented as galleries split by month. Config settings are persistent and stored into /config.
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)¶
---
+ pixapop - LinuxServer.io DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated.
linuxserver/pixapop¶
Pixapop is an open-source single page application to view your photos in the easiest way possible.
Supported Architectures¶
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/pixapop:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ✅ arm32v7-<version tag>
Application Setup¶
Any photos included in /photos will be presented as galleries split by month. Config settings are persistent and stored into /config.
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)¶
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 80WebUI
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Europe/LondonSpecify a timezone to use EG Europe/London. APP_USERNAME=adminSpecify a username to enable authentication. APP_PASSWORD=adminSpecify a password to enable authentication.
Volume Mappings (-v)¶
Volume Function /configStores config and logs for nginx base. /photosYour local folder of photos.
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:
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:
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 pixapop /bin/bash- To monitor the logs of the container in realtime:
docker logs -f pixapop- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' pixapop- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/pixapop:latest
Versions¶
- 14.10.22 - Deprecate image.
- 17.12.20 - Move image to main linuxserver repo, add notice to container log
- 18.03.19 - Update build dependencies
- 18.03.19 - Add build dependencies
- 17.03.19 - Initial release
\ No newline at end of file
+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 pixapop /bin/bash- To monitor the logs of the container in realtime:
docker logs -f pixapop- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' pixapop- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/pixapop:latest
Versions¶
- 14.10.22 - Deprecate image.
- 17.12.20 - Move image to main linuxserver repo, add notice to container log
- 18.03.19 - Update build dependencies
- 18.03.19 - Add build dependencies
- 17.03.19 - Initial release
linuxserver/plex-meta-manager¶
Plex-meta-manager is a Python 3 script that can be continuously run using YAML configuration files to update on a schedule the metadata of the movies, shows, and collections in your libraries as well as automatically build collections based on various methods all detailed in the wiki.
Supported Architectures¶
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/plex-meta-manager:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
| Tag | Available | Description |
|---|---|---|
| latest | ✅ | Stable releases. |
| develop | ✅ | Latest commits from the develop branch |
| nightly | ✅ | Latest commits from the nightly branch |
| ## Application Setup |
There is a walkthrough available to help get you up and running.
This image supports all of the environment variables listed here and all commandline arguments.
To perform a one-time run use docker run (or docker-compose run) with the --rm and -e PMM_RUN=True arguments. This will cause the container to process your config immediately instead of waiting for the scheduled time, and delete the old container after completion.
For more information see the official wiki.
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)¶
---
+ plex-meta-manager - LinuxServer.io linuxserver/plex-meta-manager¶
Plex-meta-manager is a Python 3 script that can be continuously run using YAML configuration files to update on a schedule the metadata of the movies, shows, and collections in your libraries as well as automatically build collections based on various methods all detailed in the wiki.
Supported Architectures¶
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/plex-meta-manager:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
Tag Available Description latest ✅ Stable releases. develop ✅ Latest commits from the develop branch nightly ✅ Latest commits from the nightly branch ## Application Setup
There is a walkthrough available to help get you up and running.
This image supports all of the environment variables listed here and all commandline arguments.
To perform a one-time run use docker run (or docker-compose run) with the --rm and -e PMM_RUN=True arguments. This will cause the container to process your config immediately instead of waiting for the scheduled time, and delete the old container after completion.
For more information see the official wiki.
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)¶
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
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. PMM_CONFIG=/config/config.ymlSpecify a custom config file to use. PMM_TIME=03:00Comma-separated list of times to update each day. Format: HH:MM. PMM_RUN=FalseSet to True to run without the scheduler. PMM_TEST=FalseSet to True to run in debug mode with only collections that have test: true. PMM_NO_MISSING=FalseSet to True to run without any of the missing movie/show functions.
Volume Mappings (-v)¶
Volume Function /configLocal path for plex-meta-manager config files.
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:
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:
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 plex-meta-manager /bin/bash- To monitor the logs of the container in realtime:
docker logs -f plex-meta-manager- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' plex-meta-manager- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/plex-meta-manager:latest
Versions¶
- 10.06.23: - Rebase to Alpine 3.18, deprecate armhf.
- 05.03.23: - Add nightly branch.
- 11.12.22: - Rebase master to Alpine 3.17.
- 08.11.22: - Add develop branch.
- 25.10.22: - Support commandline args and relative paths.
- 03.10.22: - Rebase to Alpine 3.16, migrate to s6v3.
- 30.01.22: - Initial Release.
\ No newline at end of file
+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 plex-meta-manager /bin/bash- To monitor the logs of the container in realtime:
docker logs -f plex-meta-manager- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' plex-meta-manager- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/plex-meta-manager:latest
Versions¶
- 10.06.23: - Rebase to Alpine 3.18, deprecate armhf.
- 05.03.23: - Add nightly branch.
- 11.12.22: - Rebase master to Alpine 3.17.
- 08.11.22: - Add develop branch.
- 25.10.22: - Support commandline args and relative paths.
- 03.10.22: - Rebase to Alpine 3.16, migrate to s6v3.
- 30.01.22: - Initial Release.
linuxserver/plex¶
Plex organizes video, music and photos from personal media libraries and streams them to smart TVs, streaming boxes and mobile devices. This container is packaged as a standalone Plex Media Server. has always been a top priority. Straightforward design and bulk actions mean getting things done faster.
Supported Architectures¶
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/plex:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
Webui can be found at <your-ip>:32400/web
** Note about updates, if there is no value set for the VERSION variable, then no updates will take place.**
** For new users, no updates will take place on the first run of the container as there is no preferences file to read your token from, to update restart the Docker container after logging in through the webui**
Valid settings for VERSION are:-
IMPORTANT NOTE:- YOU CANNOT UPDATE TO A PLEXPASS ONLY (BETA) VERSION IF YOU ARE NOT LOGGED IN WITH A PLEXPASS ACCOUNT
docker: Let Docker handle the Plex Version, we keep our Dockerhub Endpoint up to date with the latest public builds. This is the same as leaving this setting out of your create command.latest: will update plex to the latest version available that you are entitled to.public: will update plexpass users to the latest public version, useful for plexpass users that don't want to be on the bleeding edge but still want the latest public updates.<specific-version>: will select a specific version (eg 0.9.12.4.1192-9a47d21) of plex to install, note you cannot use this to access plexpass versions if you do not have plexpass.
Hardware Acceleration¶
Intel¶
Hardware acceleration users for Intel Quicksync will need to mount their /dev/dri video device inside of the container by passing the following command when running or creating the container:
--device=/dev/dri:/dev/dri
+ plex - LinuxServer.io linuxserver/plex¶
Plex organizes video, music and photos from personal media libraries and streams them to smart TVs, streaming boxes and mobile devices. This container is packaged as a standalone Plex Media Server. has always been a top priority. Straightforward design and bulk actions mean getting things done faster.
Supported Architectures¶
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/plex:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
Webui can be found at <your-ip>:32400/web
** Note about updates, if there is no value set for the VERSION variable, then no updates will take place.**
** For new users, no updates will take place on the first run of the container as there is no preferences file to read your token from, to update restart the Docker container after logging in through the webui**
Valid settings for VERSION are:-
IMPORTANT NOTE:- YOU CANNOT UPDATE TO A PLEXPASS ONLY (BETA) VERSION IF YOU ARE NOT LOGGED IN WITH A PLEXPASS ACCOUNT
docker: Let Docker handle the Plex Version, we keep our Dockerhub Endpoint up to date with the latest public builds. This is the same as leaving this setting out of your create command.latest: will update plex to the latest version available that you are entitled to.public: will update plexpass users to the latest public version, useful for plexpass users that don't want to be on the bleeding edge but still want the latest public updates.<specific-version>: will select a specific version (eg 0.9.12.4.1192-9a47d21) of plex to install, note you cannot use this to access plexpass versions if you do not have plexpass.
Hardware Acceleration¶
Intel¶
Hardware acceleration users for Intel Quicksync will need to mount their /dev/dri video device inside of the container by passing the following command when running or creating the container:
We will automatically ensure the abc user inside of the container has the proper permissions to access this device.
Nvidia¶
Hardware acceleration users for Nvidia will need to install the container runtime provided by Nvidia on their host, instructions can be found here:
https://github.com/NVIDIA/nvidia-docker
We automatically add the necessary environment variable that will utilise all the features available on a GPU on the host. Once nvidia-docker is installed on your host you will need to re/create the docker container with the nvidia container runtime --runtime=nvidia and add an environment variable -e NVIDIA_VISIBLE_DEVICES=all (can also be set to a specific gpu's UUID, this can be discovered by running nvidia-smi --query-gpu=gpu_name,gpu_uuid --format=csv ). NVIDIA automatically mounts the GPU and drivers from your host into the plex docker.
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)¶
The application accepts a series of environment variables to further customize itself on boot:
Parameter Function --device=/dev/dri:/dev/driAdd this option to your run command if you plan on using Quicksync hardware acceleration - see Application Setup section. --device=/dev/dvb:/dev/dvbAdd this option to your run command if you plan on using dvb devices.
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:
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 plex /bin/bash- To monitor the logs of the container in realtime:
docker logs -f plex- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' plex- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/plex:latest
Versions¶
- 16.08.23: - Install unrar from linuxserver repo.
- 03.07.23: - Deprecate armhf. As announced here
- 16.10.22: - Rebase to jammy. Update to s6v3. Remove opencl packages (bundled with plex).
- 18.07.22: - Pin all opencl related driver packages.
- 16.05.22: - Pin opencl version.
- 04.03.22: - Increase verbosity of video device permissions fix, attempt to fix missing group rw.
- 25.12.21: - Install Intel drivers from the official repo.
- 20.01.21: - Deprecate
UMASK_SET in favor of UMASK in baseimage, see above for more information. - 10.12.20: - Add latest Intel Compute packages from github repo for opencl support on latest gen igpu.
- 23.11.20: - Add Bionic branch make Focal default.
- 03.05.20: - Update exposed ports and example docs for bridge mode.
- 23.03.20: - Remove udev hack (no longer needed), suppress uuid error in log during first start.
- 04.12.19: - Add variable for setting PLEX_CLAIM. Remove
/transcode volume mapping as it is now set via plex gui and defaults to a location under /config. - 06.08.19: - Add variable for setting UMASK.
- 10.07.19: - Fix permissions for tuner (/dev/dvb) devices.
- 20.05.19: - Bugfix do not allow Root group for Intel QuickSync ownership rules.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.03.19: - Fix update logic for
VERSION=public. - 14.03.19: - Switch to new api endpoints, enable beta (plex pass) updates for armhf and aarch64.
- 15.02.19: - Clean up plex pid after unclean stop.
- 11.02.19: - Fix nvidia variables, add device variables.
- 16.01.19: - Add pipeline logic, multi arch, and HW transcoding configuration; remove avahi service.
- 07.09.18: - Rebase to ubuntu bionic, add udev package.
- 09.12.17: - Fix continuation lines.
- 12.07.17: - Add inspect commands to README, move to jenkins build and push.
- 28.05.17: - Add unrar package as per requests, for subzero plugin.
- 11.01.17: - Use Plex environment variables from pms docker, change abc home folder to /app to alleviate usermod chowning library
- 03.01.17: - Use case insensitive version variable matching rather than export and make lowercase.
- 17.10.16: - Allow use of uppercase version variable
- 01.10.16: - Add TZ info to README.
- 09.09.16: - Add layer badges to README.
- 27.08.16: - Add badges to README.
- 22.08.16: - Rebased to xenial and s6 overlay
- 07.04.16: - removed
/transcode volume support (upstream Plex change) and modified PlexPass download method to prevent unauthorised usage of paid PMS - 24.09.15: - added optional support for volume transcoding (/transcode), and various typo fixes.
- 17.09.15: - Changed to run chmod only once
- 19.09.15: - Plex updated their download servers from http to https
- 28.08.15: - Removed plexpass from routine, and now uses VERSION as a combination fix.
- 18.07.15: - Moved autoupdate to be hosted by linuxserver.io and implemented bugfix thanks to ljm42.
- 09.07.15: - Now with ability to pick static version number.
- 08.07.15: - Now with autoupdates. (Hosted by fanart.tv)
- 03.07.15: - Fixed a mistake that allowed plex to run as user plex rather than abc (99:100). Thanks to double16 for spotting this.
\ No newline at end of file
+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 plex /bin/bash- To monitor the logs of the container in realtime:
docker logs -f plex- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' plex- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/plex:latest
Versions¶
- 16.08.23: - Install unrar from linuxserver repo.
- 03.07.23: - Deprecate armhf. As announced here
- 16.10.22: - Rebase to jammy. Update to s6v3. Remove opencl packages (bundled with plex).
- 18.07.22: - Pin all opencl related driver packages.
- 16.05.22: - Pin opencl version.
- 04.03.22: - Increase verbosity of video device permissions fix, attempt to fix missing group rw.
- 25.12.21: - Install Intel drivers from the official repo.
- 20.01.21: - Deprecate
UMASK_SETin favor of UMASK in baseimage, see above for more information. - 10.12.20: - Add latest Intel Compute packages from github repo for opencl support on latest gen igpu.
- 23.11.20: - Add Bionic branch make Focal default.
- 03.05.20: - Update exposed ports and example docs for bridge mode.
- 23.03.20: - Remove udev hack (no longer needed), suppress uuid error in log during first start.
- 04.12.19: - Add variable for setting PLEX_CLAIM. Remove
/transcodevolume mapping as it is now set via plex gui and defaults to a location under/config. - 06.08.19: - Add variable for setting UMASK.
- 10.07.19: - Fix permissions for tuner (/dev/dvb) devices.
- 20.05.19: - Bugfix do not allow Root group for Intel QuickSync ownership rules.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.03.19: - Fix update logic for
VERSION=public. - 14.03.19: - Switch to new api endpoints, enable beta (plex pass) updates for armhf and aarch64.
- 15.02.19: - Clean up plex pid after unclean stop.
- 11.02.19: - Fix nvidia variables, add device variables.
- 16.01.19: - Add pipeline logic, multi arch, and HW transcoding configuration; remove avahi service.
- 07.09.18: - Rebase to ubuntu bionic, add udev package.
- 09.12.17: - Fix continuation lines.
- 12.07.17: - Add inspect commands to README, move to jenkins build and push.
- 28.05.17: - Add unrar package as per requests, for subzero plugin.
- 11.01.17: - Use Plex environment variables from pms docker, change abc home folder to /app to alleviate usermod chowning library
- 03.01.17: - Use case insensitive version variable matching rather than export and make lowercase.
- 17.10.16: - Allow use of uppercase version variable
- 01.10.16: - Add TZ info to README.
- 09.09.16: - Add layer badges to README.
- 27.08.16: - Add badges to README.
- 22.08.16: - Rebased to xenial and s6 overlay
- 07.04.16: - removed
/transcodevolume support (upstream Plex change) and modified PlexPass download method to prevent unauthorised usage of paid PMS - 24.09.15: - added optional support for volume transcoding (/transcode), and various typo fixes.
- 17.09.15: - Changed to run chmod only once
- 19.09.15: - Plex updated their download servers from http to https
- 28.08.15: - Removed plexpass from routine, and now uses VERSION as a combination fix.
- 18.07.15: - Moved autoupdate to be hosted by linuxserver.io and implemented bugfix thanks to ljm42.
- 09.07.15: - Now with ability to pick static version number.
- 08.07.15: - Now with autoupdates. (Hosted by fanart.tv)
- 03.07.15: - Fixed a mistake that allowed plex to run as user plex rather than abc (99:100). Thanks to double16 for spotting this.
linuxserver/projectsend¶
Projectsend is a self-hosted application that lets you upload files and assign them to specific clients that you create yourself. Secure, private and easy. No more depending on external services or e-mail to send those files.
Supported Architectures¶
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/projectsend:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
IMPORTANT This image no longer supports MSSQL since being migrated to PHP7, if you want MSSQL support please use the tag linuxserver/projectsend:r1053-ls27
Requires a user and database in either mysql or mariadb.
To use translations, follow the instructions here. The necessary paths are symlinked under /config/translations (note that the "templates" paths don't need lang subdirectories).
More info at ProjectSend.
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)¶
---
+ projectsend - LinuxServer.io linuxserver/projectsend¶
Projectsend is a self-hosted application that lets you upload files and assign them to specific clients that you create yourself. Secure, private and easy. No more depending on external services or e-mail to send those files.
Supported Architectures¶
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/projectsend:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
IMPORTANT This image no longer supports MSSQL since being migrated to PHP7, if you want MSSQL support please use the tag linuxserver/projectsend:r1053-ls27
Requires a user and database in either mysql or mariadb.
To use translations, follow the instructions here. The necessary paths are symlinked under /config/translations (note that the "templates" paths don't need lang subdirectories).
More info at ProjectSend.
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)¶
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 80WebUI
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. MAX_UPLOAD=5000To set maximum upload size (in MB), default if unset is 5000.
Volume Mappings (-v)¶
Volume Function /configWhere to store projectsend config files. /dataWhere to store files to share.
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:
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:
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 projectsend /bin/bash- To monitor the logs of the container in realtime:
docker logs -f projectsend- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' projectsend- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/projectsend:latest
Versions¶
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 08.03.23: - Rebasing to alpine 3.17 and upgrading to s6v3.
- 23.08.22: - Add translation support
- 20.08.22: - Rebasing to alpine 3.15 with php8. Restructure nginx configs (see changes announcement).
- 24.06.21: - Rebasing to alpine 3.14, switch to nginx
- 23.01.21: - Rebasing to alpine 3.13.
- 01.06.20: - Rebasing to alpine 3.12.
- 31.12.19: - Rebase to Alpine 3.11 and upgrade to PHP7.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 11.02.19: - Add pipeline logic and multi arch.
- 11.06.17: - Fetch version from github.
- 09.12.17: - Rebase to alpine 3.7.
- 13.06.17: - Initial Release.
\ No newline at end of file
+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 projectsend /bin/bash- To monitor the logs of the container in realtime:
docker logs -f projectsend- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' projectsend- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/projectsend:latest
Versions¶
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 08.03.23: - Rebasing to alpine 3.17 and upgrading to s6v3.
- 23.08.22: - Add translation support
- 20.08.22: - Rebasing to alpine 3.15 with php8. Restructure nginx configs (see changes announcement).
- 24.06.21: - Rebasing to alpine 3.14, switch to nginx
- 23.01.21: - Rebasing to alpine 3.13.
- 01.06.20: - Rebasing to alpine 3.12.
- 31.12.19: - Rebase to Alpine 3.11 and upgrade to PHP7.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 11.02.19: - Add pipeline logic and multi arch.
- 11.06.17: - Fetch version from github.
- 09.12.17: - Rebase to alpine 3.7.
- 13.06.17: - Initial Release.
linuxserver/prowlarr¶
Prowlarr is a indexer manager/proxy built on the popular arr .net/reactjs base stack to integrate with your various PVR apps. Prowlarr supports both Torrent Trackers and Usenet Indexers. It integrates seamlessly with Sonarr, Radarr, Lidarr, and Readarr offering complete management of your indexers with no per app Indexer setup required (we do it all).
Supported Architectures¶
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/prowlarr:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
| Tag | Available | Description |
|---|---|---|
| latest | ✅ | Prowlarr stable releases |
| develop | ✅ | Prowlarr releases from their develop branch |
| nightly | ✅ | Prowlarr releases from their nightly branch |
| ## Application Setup |
Access the webui at <your-ip>:9696, for more information check out Prowlarr.
Setup info can be found here.
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)¶
---
+ prowlarr - LinuxServer.io linuxserver/prowlarr¶
Prowlarr is a indexer manager/proxy built on the popular arr .net/reactjs base stack to integrate with your various PVR apps. Prowlarr supports both Torrent Trackers and Usenet Indexers. It integrates seamlessly with Sonarr, Radarr, Lidarr, and Readarr offering complete management of your indexers with no per app Indexer setup required (we do it all).
Supported Architectures¶
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/prowlarr:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
Tag Available Description latest ✅ Prowlarr stable releases develop ✅ Prowlarr releases from their develop branch nightly ✅ Prowlarr releases from their nightly branch ## Application Setup
Access the webui at <your-ip>:9696, for more information check out Prowlarr.
Setup info can be found here.
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)¶
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 9696The port for the Prowlarr webinterface
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configDatabase and Prowlarr configs
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:
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:
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 prowlarr /bin/bash- To monitor the logs of the container in realtime:
docker logs -f prowlarr- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' prowlarr- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/prowlarr:latest
Versions¶
- 06.06.23: - Rebase master to Alpine 3.18, deprecate armhf as per https://www.linuxserver.io/armhf.
- 03.01.23: - Publish stable release.
- 20.02.22: - Rebase develop branch to Alpine.
- 06.06.21: - Initial realease.
\ No newline at end of file
+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 prowlarr /bin/bash- To monitor the logs of the container in realtime:
docker logs -f prowlarr- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' prowlarr- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/prowlarr:latest
Versions¶
- 06.06.23: - Rebase master to Alpine 3.18, deprecate armhf as per https://www.linuxserver.io/armhf.
- 03.01.23: - Publish stable release.
- 20.02.22: - Rebase develop branch to Alpine.
- 06.06.21: - Initial realease.
linuxserver/pwndrop¶
Pwndrop is a self-deployable file hosting service for sending out red teaming payloads or securely sharing your private files over HTTP and WebDAV.
Supported Architectures¶
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/pwndrop:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
Access the web gui at http://<your-ip>:8080/pwndrop (replace /pwndrop with your SECRET_PATH if you set one).
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)¶
---
+ pwndrop - LinuxServer.io linuxserver/pwndrop¶
Pwndrop is a self-deployable file hosting service for sending out red teaming payloads or securely sharing your private files over HTTP and WebDAV.
Supported Architectures¶
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/pwndrop:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
Access the web gui at http://<your-ip>:8080/pwndrop (replace /pwndrop with your SECRET_PATH if you set one).
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)¶
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 8080web gui
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. SECRET_PATH=/pwndropSecret path for admin access. Defaults to /pwndrop. This parameter only takes effect during initial install; it can later be changed in the web gui.
Volume Mappings (-v)¶
Volume Function /configContains all relevant configuration and data.
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:
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:
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 pwndrop /bin/bash- To monitor the logs of the container in realtime:
docker logs -f pwndrop- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' pwndrop- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/pwndrop:latest
Versions¶
- 07.08.23: - Rebase to Alpine 3.18.
- 03.07.23: - Deprecate armhf. As announced here
- 13.02.23: - Rebase to Alpine 3.17, migrate to s6v3.
- 19.09.22: - Rebasing to alpine 3.15.
- 23.01.21: - Rebasing to alpine 3.13.
- 01.06.20: - Rebasing to alpine 3.12.
- 17.04.20: - Initial Release.
\ No newline at end of file
+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 pwndrop /bin/bash- To monitor the logs of the container in realtime:
docker logs -f pwndrop- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' pwndrop- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/pwndrop:latest
Versions¶
- 07.08.23: - Rebase to Alpine 3.18.
- 03.07.23: - Deprecate armhf. As announced here
- 13.02.23: - Rebase to Alpine 3.17, migrate to s6v3.
- 19.09.22: - Rebasing to alpine 3.15.
- 23.01.21: - Rebasing to alpine 3.13.
- 01.06.20: - Rebasing to alpine 3.12.
- 17.04.20: - Initial Release.
linuxserver/pydio-cells¶
Pydio-cells is the nextgen file sharing platform for organizations. It is a full rewrite of the Pydio project using the Go language following a micro-service architecture.
Supported Architectures¶
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/pydio-cells:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
You must first create a mysql database for Pydio Cells. Using our mariadb image is recommended.
Then access the web gui setup wizard at https://SERVER_IP:8080 if accessing locally (must set SERVER_IP env var), or at https://pydio-cells.domain.com if reverse proxying.
Strict reverse proxies¶
This image uses a self-signed certificate by default. This naturally means the scheme is https. If you are using a reverse proxy which validates certificates, you need to disable this check for the container.
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)¶
---
+ pydio-cells - LinuxServer.io linuxserver/pydio-cells¶
Pydio-cells is the nextgen file sharing platform for organizations. It is a full rewrite of the Pydio project using the Go language following a micro-service architecture.
Supported Architectures¶
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/pydio-cells:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
You must first create a mysql database for Pydio Cells. Using our mariadb image is recommended.
Then access the web gui setup wizard at https://SERVER_IP:8080 if accessing locally (must set SERVER_IP env var), or at https://pydio-cells.domain.com if reverse proxying.
Strict reverse proxies¶
This image uses a self-signed certificate by default. This naturally means the scheme is https. If you are using a reverse proxy which validates certificates, you need to disable this check for the container.
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)¶
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 8080Http port 33060gRPC port (required for CellsSync).
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. EXTERNALURL=yourdomain.urlThe external url you would like to use to access Pydio Cells (Can be https://domain.url or https://IP:PORT). SERVER_IP=0.0.0.0Enter the LAN IP of the docker server. Required for local access by IP, added to self signed cert as SAN (not required if accessing only through reverse proxy).
Volume Mappings (-v)¶
Volume Function /configAll the config files reside here.
Miscellaneous Options¶
Parameter Function --hostname=Pydio Cells uses the hostname to verify local files. This setting is required and should not be changed after it has been set.
Environment variables from files (Docker secrets)¶
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
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:
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 pydio-cells /bin/bash- To monitor the logs of the container in realtime:
docker logs -f pydio-cells- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' pydio-cells- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/pydio-cells:latest
Versions¶
- 06.07.23: - Deprecate armhf. As announced here
- 01.12.22: - Rebasing to alpine 3.17. Adding multi-arch support. Updating cli arguments for v4 compatibility.
- 19.10.22: - Rebasing to alpine 3.16. Upgrading to s6v3. Updating build instructions for v4.
- 19.09.22: - Rebasing to alpine 3.15.
- 23.01.21: - Rebasing to alpine 3.13.
- 01.06.20: - Rebasing to alpine 3.12.
- 18.04.20: - Switch to https as default (only affects new installs). Add self signed cert, add
SERVER_IP var for adding to cert as SAN. Add optional gRPC port mapping for CellsSync. - 17.04.20: - Update compile options, previous release was broken for new installs.
- 19.12.19: - Rebasing to alpine 3.11.
- 12.12.19: - Initial Release
\ No newline at end of file
+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 pydio-cells /bin/bash- To monitor the logs of the container in realtime:
docker logs -f pydio-cells- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' pydio-cells- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/pydio-cells:latest
Versions¶
- 06.07.23: - Deprecate armhf. As announced here
- 01.12.22: - Rebasing to alpine 3.17. Adding multi-arch support. Updating cli arguments for v4 compatibility.
- 19.10.22: - Rebasing to alpine 3.16. Upgrading to s6v3. Updating build instructions for v4.
- 19.09.22: - Rebasing to alpine 3.15.
- 23.01.21: - Rebasing to alpine 3.13.
- 01.06.20: - Rebasing to alpine 3.12.
- 18.04.20: - Switch to https as default (only affects new installs). Add self signed cert, add
SERVER_IPvar for adding to cert as SAN. Add optional gRPC port mapping for CellsSync. - 17.04.20: - Update compile options, previous release was broken for new installs.
- 19.12.19: - Rebasing to alpine 3.11.
- 12.12.19: - Initial Release
DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated.
linuxserver/pydio¶
Pydio (formerly AjaXplorer) is a mature open source software solution for file sharing and synchronization. With intuitive user interfaces (web / mobile / desktop), Pydio provides enterprise-grade features to gain back control and privacy of your data: user directory connectors, legacy filesystems drivers, comprehensive admin interface, and much more.
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/pydio 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 | amd64-latest |
| arm64 | arm64v8-latest |
| armhf | arm32v7-latest |
Usage¶
Here are some example snippets to help you get started creating a container from this image.
docker-compose (recommended)¶
Compatible with docker-compose v2 schemas.
---
+ pydio - LinuxServer.io DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated.
linuxserver/pydio¶
Pydio (formerly AjaXplorer) is a mature open source software solution for file sharing and synchronization. With intuitive user interfaces (web / mobile / desktop), Pydio provides enterprise-grade features to gain back control and privacy of your data: user directory connectors, legacy filesystems drivers, comprehensive admin interface, and much more.
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/pydio 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 amd64-latest arm64 arm64v8-latest armhf arm32v7-latest
Usage¶
Here are some example snippets to help you get started creating a container from this image.
docker-compose (recommended)¶
Compatible with docker-compose v2 schemas.
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 443WebUI
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Europe/LondonSpecify a timezone to use EG Europe/London.
Volume Mappings (-v)¶
Volume Function /configWhere pydio should store it's configuration files. /dataWhere pydio should store uploaded files.
Environment variables from files (Docker secrets)¶
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
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:
Application Setup¶
THIS IMAGE IS DEPRECATED. You can switch to Pydio Cells instead.
You must create a user and database for pydio to use in a mysql/mariadb or postgresql server. You can use sqlite with no further config needed, but this should only be considered for testing purposes. In the setup page for database, use the ip address rather than hostname...
Self-signed keys are generated the first time you run the container and can be found in /config/keys , if needed, you can replace them with your own.
For public link sharing to function correctly be sure to change the Detected Server Url to the URL of your pydio instance in the setup wizard.
For email settings edit the file /config/ssmtp.conf and restart the container.
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 pydio /bin/bash- To monitor the logs of the container in realtime:
docker logs -f pydio- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' pydio- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/pydio
Versions¶
- 23.01.21: - Rebasing to alpine 3.13.
- 01.06.20: - Rebasing to alpine 3.12.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 11.02.19: - Add pipeline logic and multi arch, rebase to alpine 3.8.
- 12.01.18: - Rebase to alpine linux 3.7.
- 28.10.17: - php7-ssh2 moved from testing to community repo.
- 25.05.17: - Rebase to alpine linux 3.6.
- 17.05.17: - Make default install pydio 8.
- 03.05.17: - Use repo pinning to better solve dependencies, use repo version of php7-imagick.
- 28.02.17: - Modify sed for data path.
- 18.02.17: - Rebase to alpine linux 3.5.
- 05.11.16: - Pinned at latest sourceforge download version, in lieu of a full rewrite.
- 14.10.16: - Add version layer information.
- 10.09.16: - Add layer badges to README.
- 08.09.15: - Initial Release.
\ No newline at end of file
+Application Setup¶
THIS IMAGE IS DEPRECATED. You can switch to Pydio Cells instead.
You must create a user and database for pydio to use in a mysql/mariadb or postgresql server. You can use sqlite with no further config needed, but this should only be considered for testing purposes. In the setup page for database, use the ip address rather than hostname...
Self-signed keys are generated the first time you run the container and can be found in /config/keys , if needed, you can replace them with your own.
For public link sharing to function correctly be sure to change the Detected Server Url to the URL of your pydio instance in the setup wizard.
For email settings edit the file /config/ssmtp.conf and restart the container.
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 pydio /bin/bash- To monitor the logs of the container in realtime:
docker logs -f pydio- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' pydio- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/pydio
Versions¶
- 23.01.21: - Rebasing to alpine 3.13.
- 01.06.20: - Rebasing to alpine 3.12.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 11.02.19: - Add pipeline logic and multi arch, rebase to alpine 3.8.
- 12.01.18: - Rebase to alpine linux 3.7.
- 28.10.17: - php7-ssh2 moved from testing to community repo.
- 25.05.17: - Rebase to alpine linux 3.6.
- 17.05.17: - Make default install pydio 8.
- 03.05.17: - Use repo pinning to better solve dependencies, use repo version of php7-imagick.
- 28.02.17: - Modify sed for data path.
- 18.02.17: - Rebase to alpine linux 3.5.
- 05.11.16: - Pinned at latest sourceforge download version, in lieu of a full rewrite.
- 14.10.16: - Add version layer information.
- 10.09.16: - Add layer badges to README.
- 08.09.15: - Initial Release.
linuxserver/pyload-ng¶
pyLoad is a Free and Open Source download manager written in Python and designed to be extremely lightweight, easily extensible and fully manageable via web.
Supported Architectures¶
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/pyload-ng:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
| Tag | Available | Description |
|---|---|---|
| latest | ✅ | Stable releases from pyLoad Next |
| develop | ✅ | Releases from pyload Next develop branch |
| ## Application Setup |
Access the web interface at http://your-ip:8000 the default login is: username - pyload password - pyload
For general usage please see the pyLoad wiki here .
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)¶
---
+ pyload-ng - LinuxServer.io linuxserver/pyload-ng¶
pyLoad is a Free and Open Source download manager written in Python and designed to be extremely lightweight, easily extensible and fully manageable via web.
Supported Architectures¶
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/pyload-ng:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
Tag Available Description latest ✅ Stable releases from pyLoad Next develop ✅ Releases from pyload Next develop branch ## Application Setup
Access the web interface at http://your-ip:8000 the default login is: username - pyload password - pyload
For general usage please see the pyLoad wiki here .
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)¶
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 8000Allows HTTP access to the application 9666Click'n'Load port.
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configpyLoad Configuration and files database /downloadsDestination of pyLoad downloads
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:
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:
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 pyload-ng /bin/bash- To monitor the logs of the container in realtime:
docker logs -f pyload-ng- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' pyload-ng- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/pyload-ng:latest
Versions¶
- 10.08.23: - Bump unrar to 6.2.10.
- 01.06.23: - Replace p7zip with 7zip, add unrar.
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 02.02.22: - Rebase master to alpine 3.17.
- 02.02.22: - Add ffmpeg for the Youtube plugin.
- 24.01.22: - Replace unrar with p7zip.
- 24.01.22: - Initial release.
\ No newline at end of file
+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 pyload-ng /bin/bash- To monitor the logs of the container in realtime:
docker logs -f pyload-ng- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' pyload-ng- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/pyload-ng:latest
Versions¶
- 10.08.23: - Bump unrar to 6.2.10.
- 01.06.23: - Replace p7zip with 7zip, add unrar.
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 02.02.22: - Rebase master to alpine 3.17.
- 02.02.22: - Add ffmpeg for the Youtube plugin.
- 24.01.22: - Replace unrar with p7zip.
- 24.01.22: - Initial release.
DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. We recommend our new pyload-ng image instead: https://github.com/linuxserver/docker-pyload-ng/
linuxserver/pyload¶
Pyload is a Free and Open Source download manager written in Python and designed to be extremely lightweight, easily extensible and fully manageable via web.
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/pyload 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 | amd64-latest |
| arm64 | arm64v8-latest |
| armhf | arm32v7-latest |
Version Tags¶
This image provides various versions that are available via tags. latest tag usually provides the latest stable version. Others are considered under development and caution must be exercised when using them.
| Tag | Description |
|---|---|
| latest | Stable releases from Pyload |
| ng | Development releases from Pyload-ng (currently alpha) |
Application Setup¶
Access the web interface at http://your-ip:8000 the default login is: username - admin password - password
For the ng tag, the default user/pass are pyload/pyload.
For general usage please see the pyLoad wiki here .
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)¶
---
+ pyload - LinuxServer.io DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. We recommend our new pyload-ng image instead: https://github.com/linuxserver/docker-pyload-ng/
linuxserver/pyload¶
Pyload is a Free and Open Source download manager written in Python and designed to be extremely lightweight, easily extensible and fully manageable via web.
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/pyload 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 amd64-latest arm64 arm64v8-latest armhf arm32v7-latest
Version Tags¶
This image provides various versions that are available via tags. latest tag usually provides the latest stable version. Others are considered under development and caution must be exercised when using them.
Tag Description latest Stable releases from Pyload ng Development releases from Pyload-ng (currently alpha)
Application Setup¶
Access the web interface at http://your-ip:8000 the default login is: username - admin password - password
For the ng tag, the default user/pass are pyload/pyload.
For general usage please see the pyLoad wiki here .
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)¶
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 8000Allows HTTP access to the application 7227pyLoad control port
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Europe/LondonSpecify a timezone to use EG Europe/London
Volume Mappings (-v)¶
Volume Function /configpyLoad Configuration and files database /downloadsDestination of pyLoad downloads
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:
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:
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 pyload /bin/bash- To monitor the logs of the container in realtime:
docker logs -f pyload- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' pyload- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/pyload
Versions¶
- 25.01.22: - Deprecate.
- 23.02.21: - Add Python plugin
passlib. - 16.02.21: - Publish
ng tag for pyload-ng (currently alpha). - 04.11.20: - Rebase to alpine 3.11.
- 18.10.20: - Chown app folder to fix plugin updater.
- 18.07.19: - Add ffmpeg for plugins the do video processing.
- 28.06.19: - Rebasing to alpine 3.10.
- 08.06.19: - Initial release.
\ No newline at end of file
+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 pyload /bin/bash- To monitor the logs of the container in realtime:
docker logs -f pyload- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' pyload- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/pyload
Versions¶
- 25.01.22: - Deprecate.
- 23.02.21: - Add Python plugin
passlib. - 16.02.21: - Publish
ngtag for pyload-ng (currently alpha). - 04.11.20: - Rebase to alpine 3.11.
- 18.10.20: - Chown app folder to fix plugin updater.
- 18.07.19: - Add ffmpeg for plugins the do video processing.
- 28.06.19: - Rebasing to alpine 3.10.
- 08.06.19: - Initial release.
linuxserver/pylon¶
Pylon is a web based integrated development environment built with Node.js as a backend and with a supercharged JavaScript/HTML5 frontend, licensed under GPL version 3. This project originates from Cloud9 v2 project.
Supported Architectures¶
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/pylon:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
Access the webui at http://your-ip:3131, more information here.
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)¶
---
+ pylon - LinuxServer.io linuxserver/pylon¶
Pylon is a web based integrated development environment built with Node.js as a backend and with a supercharged JavaScript/HTML5 frontend, licensed under GPL version 3. This project originates from Cloud9 v2 project.
Supported Architectures¶
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/pylon:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
Access the webui at http://your-ip:3131, more information here.
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)¶
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 3131The port for the Pylon web interface
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. GITURL=https://github.com/linuxserver/docker-pylon.gitSpecify a git repo to checkout on first startup PYUSER=myuserSpecify a basic auth user. PYPASS=mypassSpecify a basic auth password.
Volume Mappings (-v)¶
Volume Function /codeOptionally if you want the bind mount your own code and have changes survive container upgrades.
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:
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:
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 pylon /bin/bash- To monitor the logs of the container in realtime:
docker logs -f pylon- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' pylon- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/pylon:latest
Versions¶
- 12.07.23: - Rebase to Alpine 3.18
- 04.07.23: - Deprecate armhf. As announced here
- 13.02.23: - Rebase to Alpine 3.17, migrate to s6v3.
- 19.01.22: - Rebasing to alpine 3.15.
- 02.06.20: - Rebasing to alpine 3.12.
- 19.12.19: - Rebasing to alpine 3.11.
- 19.09.19: - Initial Release.
\ No newline at end of file
+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 pylon /bin/bash- To monitor the logs of the container in realtime:
docker logs -f pylon- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' pylon- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/pylon:latest
Versions¶
- 12.07.23: - Rebase to Alpine 3.18
- 04.07.23: - Deprecate armhf. As announced here
- 13.02.23: - Rebase to Alpine 3.17, migrate to s6v3.
- 19.01.22: - Rebasing to alpine 3.15.
- 02.06.20: - Rebasing to alpine 3.12.
- 19.12.19: - Rebasing to alpine 3.11.
- 19.09.19: - Initial Release.
linuxserver/qbittorrent¶
The Qbittorrent project aims to provide an open-source software alternative to µTorrent. qBittorrent is based on the Qt toolkit and libtorrent-rasterbar library.
Supported Architectures¶
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/qbittorrent:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
| Tag | Available | Description |
|---|---|---|
| latest | ✅ | Stable qbittorrent releases |
| libtorrentv1 | ✅ | Static qbittorrent builds using libtorrent v1 |
| ## Application Setup |
The webui is at <your-ip>:8080 and the default username/password is admin/adminadmin.
Change username/password via the webui in the webui section of settings.
WEBUI_PORT variable¶
Due to issues with CSRF and port mapping, should you require to alter the port for the webui you need to change both sides of the -p 8080 switch AND set the WEBUI_PORT variable to the new port.
For example, to set the port to 8090 you need to set -p 8090:8090 and -e WEBUI_PORT=8090
This should alleviate the "white screen" issue.
If you have no webui , check the file /config/qBittorrent/qBittorrent.conf
edit or add the following lines
WebUI\Address=*
+ qbittorrent - LinuxServer.io linuxserver/qbittorrent¶
The Qbittorrent project aims to provide an open-source software alternative to µTorrent. qBittorrent is based on the Qt toolkit and libtorrent-rasterbar library.
Supported Architectures¶
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/qbittorrent:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
Tag Available Description latest ✅ Stable qbittorrent releases libtorrentv1 ✅ Static qbittorrent builds using libtorrent v1 ## Application Setup
The webui is at <your-ip>:8080 and the default username/password is admin/adminadmin.
Change username/password via the webui in the webui section of settings.
WEBUI_PORT variable¶
Due to issues with CSRF and port mapping, should you require to alter the port for the webui you need to change both sides of the -p 8080 switch AND set the WEBUI_PORT variable to the new port.
For example, to set the port to 8090 you need to set -p 8090:8090 and -e WEBUI_PORT=8090
This should alleviate the "white screen" issue.
If you have no webui , check the file /config/qBittorrent/qBittorrent.conf
edit or add the following lines
If you are running a very old (3.x) kernel you may run into this issue which can be worked around using this method
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)¶
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 8080WebUI 6881tcp connection port 6881/udpudp connection port
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. WEBUI_PORT=8080for changing the port of the webui, see below for explanation
Volume Mappings (-v)¶
Volume Function /configContains all relevant configuration files. /downloadsLocation of downloads on disk.
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:
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:
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 qbittorrent /bin/bash- To monitor the logs of the container in realtime:
docker logs -f qbittorrent- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' qbittorrent- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/qbittorrent:latest
Versions¶
- 10.08.23: - Bump unrar to 6.2.10.
- 17.06.23: - Deprecate armhf as per https://www.linuxserver.io/armhf.
- 10.06.23: - Bump unrar to 6.2.8.
- 23.02.23: - Add qt6-qtbase-sqlite to support SQLite database for resume files.
- 29.11.22: - Add openssl1.1-compat for qbittorrent-cli.
- 31.10.22: - Add libtorrentv1 branch.
- 31.08.22: - Rebase to Alpine Edge again to follow latest releases.
- 12.08.22: - Bump unrar to 6.1.7.
- 16.06.22: - Rebase to Alpine 3.16 from edge.
- 25.05.22: - Fetch qbitorrent-cli from upstream repo.
- 02.03.22: - Add unrar, 7zip, and qbitorrent-cli.
- 01.03.22: - Add python for search plugin support.
- 23.02.22: - Rebase to Alpine Edge, install from Alpine repos.
- 19.02.22: - Add jq to build-stage
- 07.01.22: - Rebase to Alpine, build from source.
- 06.01.22: - Deprecate unstable branch.
- 10.02.21: - Rebase to focal.
- 20.01.21: - Deprecate
UMASK_SET in favor of UMASK in baseimage, see above for more information. - 12.11.20: - Stop creating /config/data directory on startup
- 03.04.20: - Fix adding search engine plugin
- 02.08.19: - Add qbitorrent-cli for processing scripts.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 14.01.19: - Rebase to Ubuntu, add multi arch and pipeline logic.
- 25.09.18: - Use buildstage type build, bump qbitorrent to 4.1.3.
- 14.08.18: - Rebase to alpine 3.8, bump libtorrent to 1.1.9 and qbitorrent to 4.1.2.
- 08.06.18: - Bump qbitorrent to 4.1.1.
- 26.04.18: - Bump libtorrent to 1.1.7.
- 02.03.18: - Bump qbitorrent to 4.0.4 and libtorrent to 1.1.6.
- 02.01.18: - Deprecate cpu_core routine lack of scaling.
- 19.12.17: - Update to v4.0.3.
- 09.02.17: - Rebase to alpine 3.7
- 01.12.17: - Update to v4.0.2.
- 27.11.17: - Update to v4 and use cpu_core routine to speed up builds.
- 16.09.17: - Bump to 3.3.16, Add WEBUI_PORT variable and notes to README to allow changing port of webui.
- 01.08.17: - Initial Release.
- 12.02.18: - Initial Release.
\ No newline at end of file
+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 qbittorrent /bin/bash- To monitor the logs of the container in realtime:
docker logs -f qbittorrent- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' qbittorrent- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/qbittorrent:latest
Versions¶
- 10.08.23: - Bump unrar to 6.2.10.
- 17.06.23: - Deprecate armhf as per https://www.linuxserver.io/armhf.
- 10.06.23: - Bump unrar to 6.2.8.
- 23.02.23: - Add qt6-qtbase-sqlite to support SQLite database for resume files.
- 29.11.22: - Add openssl1.1-compat for qbittorrent-cli.
- 31.10.22: - Add libtorrentv1 branch.
- 31.08.22: - Rebase to Alpine Edge again to follow latest releases.
- 12.08.22: - Bump unrar to 6.1.7.
- 16.06.22: - Rebase to Alpine 3.16 from edge.
- 25.05.22: - Fetch qbitorrent-cli from upstream repo.
- 02.03.22: - Add unrar, 7zip, and qbitorrent-cli.
- 01.03.22: - Add python for search plugin support.
- 23.02.22: - Rebase to Alpine Edge, install from Alpine repos.
- 19.02.22: - Add jq to build-stage
- 07.01.22: - Rebase to Alpine, build from source.
- 06.01.22: - Deprecate unstable branch.
- 10.02.21: - Rebase to focal.
- 20.01.21: - Deprecate
UMASK_SETin favor of UMASK in baseimage, see above for more information. - 12.11.20: - Stop creating /config/data directory on startup
- 03.04.20: - Fix adding search engine plugin
- 02.08.19: - Add qbitorrent-cli for processing scripts.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 14.01.19: - Rebase to Ubuntu, add multi arch and pipeline logic.
- 25.09.18: - Use buildstage type build, bump qbitorrent to 4.1.3.
- 14.08.18: - Rebase to alpine 3.8, bump libtorrent to 1.1.9 and qbitorrent to 4.1.2.
- 08.06.18: - Bump qbitorrent to 4.1.1.
- 26.04.18: - Bump libtorrent to 1.1.7.
- 02.03.18: - Bump qbitorrent to 4.0.4 and libtorrent to 1.1.6.
- 02.01.18: - Deprecate cpu_core routine lack of scaling.
- 19.12.17: - Update to v4.0.3.
- 09.02.17: - Rebase to alpine 3.7
- 01.12.17: - Update to v4.0.2.
- 27.11.17: - Update to v4 and use cpu_core routine to speed up builds.
- 16.09.17: - Bump to 3.3.16, Add WEBUI_PORT variable and notes to README to allow changing port of webui.
- 01.08.17: - Initial Release.
- 12.02.18: - Initial Release.
linuxserver/qdirstat¶
QDirStat Qt-based directory statistics: KDirStat without any KDE -- from the author of the original KDirStat.
Supported Architectures¶
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/qdirstat:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
The application can be accessed at:
- http://yourhost:3000/
- https://yourhost:3001/
Options in all KasmVNC based GUI containers¶
This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.
Optional environment variables¶
| Variable | Description |
|---|---|
| CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default 3000. |
| CUSTOM_HTTPS_PORT | Internal port the container listens on for https if it needs to be swapped from the default 3001. |
| CUSTOM_USER | HTTP Basic auth username, abc is default. |
| PASSWORD | HTTP Basic auth password, abc is default. If unset there will be no auth |
| SUBFOLDER | Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/ |
| TITLE | The page title displayed on the web browser, default "KasmVNC Client". |
| FM_HOME | This is the home directory (landing) for the file manager, default "/config". |
| START_DOCKER | If set to false a container with privilege will not automatically start the DinD Docker setup. |
| DRINODE | If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE /dev/dri/renderD128 |
Optional run configurations¶
| Variable | Description |
|---|---|
--privileged | Will start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE -v /home/user/docker-data:/var/lib/docker. |
-v /var/run/docker.sock:/var/run/docker.sock | Mount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. |
--device /dev/dri:/dev/dri | Mount a GPU into the container, this can be used in conjunction with the DRINODE environment variable to leverage a host video card for GPU accelerated appplications. Only Open Source drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau) |
Lossless mode¶
This container is capable of delivering a true lossless image at a high framerate to your web browser by changing the Stream Quality preset to "Lossless", more information here. In order to use this mode from a non localhost endpoint the HTTPS port on 3001 needs to be used. If using a reverse proxy to port 3000 specific headers will need to be set as outlined here.
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)¶
---
+ qdirstat - LinuxServer.io linuxserver/qdirstat¶
QDirStat Qt-based directory statistics: KDirStat without any KDE -- from the author of the original KDirStat.
Supported Architectures¶
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/qdirstat:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
The application can be accessed at:
- http://yourhost:3000/
- https://yourhost:3001/
Options in all KasmVNC based GUI containers¶
This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.
Optional environment variables¶
Variable Description CUSTOM_PORT Internal port the container listens on for http if it needs to be swapped from the default 3000. CUSTOM_HTTPS_PORT Internal port the container listens on for https if it needs to be swapped from the default 3001. CUSTOM_USER HTTP Basic auth username, abc is default. PASSWORD HTTP Basic auth password, abc is default. If unset there will be no auth SUBFOLDER Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/ TITLE The page title displayed on the web browser, default "KasmVNC Client". FM_HOME This is the home directory (landing) for the file manager, default "/config". START_DOCKER If set to false a container with privilege will not automatically start the DinD Docker setup. DRINODE If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE /dev/dri/renderD128
Optional run configurations¶
Variable Description --privilegedWill start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE -v /home/user/docker-data:/var/lib/docker. -v /var/run/docker.sock:/var/run/docker.sockMount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. --device /dev/dri:/dev/driMount a GPU into the container, this can be used in conjunction with the DRINODE environment variable to leverage a host video card for GPU accelerated appplications. Only Open Source drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau)
Lossless mode¶
This container is capable of delivering a true lossless image at a high framerate to your web browser by changing the Stream Quality preset to "Lossless", more information here. In order to use this mode from a non localhost endpoint the HTTPS port on 3001 needs to be used. If using a reverse proxy to port 3000 specific headers will need to be set as outlined here.
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)¶
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 3000QdirStat desktop gui. 3001QdirStat desktop gui HTTPS.
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configUsers home directory in the container, stores qdirstat settings and scans. /dataData you want to analyze disk usage information of.
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:
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:
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 qdirstat /bin/bash- To monitor the logs of the container in realtime:
docker logs -f qdirstat- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' qdirstat- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/qdirstat:latest
Versions¶
- 03.04.23: - Rebase to KasmVNC base image. Deprecate armhf build as the new base does not support it.
- 16.12.22: - Rebase to Jammy.
- 06.04.22: - Add xfce terminal.
- 13.01.22: - Compile from source.
- 11.01.22: - Initial release.
\ No newline at end of file
+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 qdirstat /bin/bash- To monitor the logs of the container in realtime:
docker logs -f qdirstat- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' qdirstat- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/qdirstat:latest
Versions¶
- 03.04.23: - Rebase to KasmVNC base image. Deprecate armhf build as the new base does not support it.
- 16.12.22: - Rebase to Jammy.
- 06.04.22: - Add xfce terminal.
- 13.01.22: - Compile from source.
- 11.01.22: - Initial release.
linuxserver/quassel-core¶
Quassel-core is a modern, cross-platform, distributed IRC client, meaning that one (or multiple) client(s) can attach to and detach from a central core.
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.
Supported Architectures¶
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/quassel-core:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
Quassel wiki: quassel
A great place to host a quassel instance is a VPS, such as DigitalOcean. 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).
Once you have the container running, fire up a quassel desktop client and connect to your new core instance using your droplets public IP address and the port you specified in your docker run command default: 4242. Create an admin user, select SQLite as your storage backend (Quassel limitation). Setup your real name and nick, then press Save & Connect.
You're now connected to IRC. Let's add you to our 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.
Stateless usage¶
To use Quassel in stateless mode, where it needs to be configured through environment arguments, run it with the --config-from-environment RUN_OPTS environment setting.
| Env | Usage |
|---|---|
| DB_BACKEND | SQLite or PostgreSQL |
| DB_PGSQL_USERNAME | PostgreSQL User |
| DB_PGSQL_PASSWORD | PostgreSQL Password |
| DB_PGSQL_HOSTNAME | PostgreSQL Host |
| DB_PGSQL_PORT | PostgreSQL Port |
| AUTH_AUTHENTICATOR | Database or LDAP |
| AUTH_LDAP_HOSTNAME | LDAP Host |
| AUTH_LDAP_PORT | LDAP Port |
| AUTH_LDAP_BIND_DN | LDAP Bind Domain |
| AUTH_LDAP_BIND_PASSWORD | LDAP Password |
| AUTH_LDAP_FILTER | LDAP Authentication Filters |
| AUTH_LDAP_UID_ATTRIBUTE | LDAP UID |
Additionally you have RUN_OPTS that can be used to customize pathing and behvior.
| Option | Example |
|---|---|
| --strict-ident | strictly bool --strict-ident |
| --ident-daemon | strictly bool --ident-daemon |
| --ident-port | --ident-port "10113" |
| --ident-listen | --ident-listen "::,0.0.0.0" |
| --ssl-cert | --ssl-cert /config/keys/cert.crt |
| --ssl-key | --ssl-key /config/keys/cert.key |
| --require-ssl | strictly bool --require-ssl |
Minimal example with SQLite:
docker create \
+ quassel-core - LinuxServer.io linuxserver/quassel-core¶
Quassel-core is a modern, cross-platform, distributed IRC client, meaning that one (or multiple) client(s) can attach to and detach from a central core.
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.
Supported Architectures¶
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/quassel-core:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
Quassel wiki: quassel
A great place to host a quassel instance is a VPS, such as DigitalOcean. 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).
Once you have the container running, fire up a quassel desktop client and connect to your new core instance using your droplets public IP address and the port you specified in your docker run command default: 4242. Create an admin user, select SQLite as your storage backend (Quassel limitation). Setup your real name and nick, then press Save & Connect.
You're now connected to IRC. Let's add you to our 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.
Stateless usage¶
To use Quassel in stateless mode, where it needs to be configured through environment arguments, run it with the --config-from-environment RUN_OPTS environment setting.
Env Usage DB_BACKEND SQLite or PostgreSQL DB_PGSQL_USERNAME PostgreSQL User DB_PGSQL_PASSWORD PostgreSQL Password DB_PGSQL_HOSTNAME PostgreSQL Host DB_PGSQL_PORT PostgreSQL Port AUTH_AUTHENTICATOR Database or LDAP AUTH_LDAP_HOSTNAME LDAP Host AUTH_LDAP_PORT LDAP Port AUTH_LDAP_BIND_DN LDAP Bind Domain AUTH_LDAP_BIND_PASSWORD LDAP Password AUTH_LDAP_FILTER LDAP Authentication Filters AUTH_LDAP_UID_ATTRIBUTE LDAP UID
Additionally you have RUN_OPTS that can be used to customize pathing and behvior.
Option Example --strict-ident strictly bool --strict-ident --ident-daemon strictly bool --ident-daemon --ident-port --ident-port "10113" --ident-listen --ident-listen "::,0.0.0.0" --ssl-cert --ssl-cert /config/keys/cert.crt --ssl-key --ssl-key /config/keys/cert.key --require-ssl strictly bool --require-ssl
Minimal example with SQLite:
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 4242The port quassel-core listens for connections on. 10113Optional Ident Port
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. RUN_OPTS=--config-from-environmentCustom CLI options for Quassel
Volume Mappings (-v)¶
Volume Function /configDatabase and quassel-core configuration storage.
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:
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:
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 quassel-core /bin/bash- To monitor the logs of the container in realtime:
docker logs -f quassel-core- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' quassel-core- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/quassel-core:latest
Versions¶
- 03.07.23: - Deprecate armhf. As announced here
- 13.02.23: - Rebase to Alpine 3.17, migrate to s6v3.
- 03.01.22: - Rebase to alpine 3.15. Add new build deps and apply other fixes for 0.14.
- 07.08.21: - Fixing incorrect database password variable operator.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 20.03.19: - Make stateless operation an option, with input from one of the quassel team.
- 26.01.19: - Add pipeline logic and multi arch.
- 08.01.19: - Rebase to Ubuntu Bionic and upgrade to Quassel
0.13.0 See here.. - 30.07.18: - Rebase to alpine:3.8 and use buildstage.
- 03.01.18: - Deprecate cpu_core routine lack of scaling.
- 09.12.17: - Rebase to alpine:3.7.
- 26.11.17: - Use cpu core counting routine to speed up build time.
- 12.07.17: - Add inspect commands to README, move to jenkins build and push.
- 27.05.17: - Rebase to alpine:3.6.
- 13.05.17: - Switch to git source.
- 28.12.16: - Rebase to alpine:3.5.
- 23.11.16: - Rebase to alpine:edge.
- 23.09.16: - Use QT5 dependencies (thanks bauerj).
- 10.09.16: - Add layer badges to README.
- 28.08.16: - Add badges to README.
- 10.08.16: - Rebase to xenial.
- 14.10.15: - Removed the webui, turned out to be to unstable for most usecases.
- 01.09.15: - Fixed mistake in README.
- 30.07.15: - Switched to internal baseimage, and fixed a bug with updating the webinterface.
- 06.07.15: - Enabled BLOWFISH encryption and added a (optional) webinterface, for the times you dont have access to your client.
\ No newline at end of file
+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 quassel-core /bin/bash- To monitor the logs of the container in realtime:
docker logs -f quassel-core- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' quassel-core- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/quassel-core:latest
Versions¶
- 03.07.23: - Deprecate armhf. As announced here
- 13.02.23: - Rebase to Alpine 3.17, migrate to s6v3.
- 03.01.22: - Rebase to alpine 3.15. Add new build deps and apply other fixes for 0.14.
- 07.08.21: - Fixing incorrect database password variable operator.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 20.03.19: - Make stateless operation an option, with input from one of the quassel team.
- 26.01.19: - Add pipeline logic and multi arch.
- 08.01.19: - Rebase to Ubuntu Bionic and upgrade to Quassel
0.13.0See here.. - 30.07.18: - Rebase to alpine:3.8 and use buildstage.
- 03.01.18: - Deprecate cpu_core routine lack of scaling.
- 09.12.17: - Rebase to alpine:3.7.
- 26.11.17: - Use cpu core counting routine to speed up build time.
- 12.07.17: - Add inspect commands to README, move to jenkins build and push.
- 27.05.17: - Rebase to alpine:3.6.
- 13.05.17: - Switch to git source.
- 28.12.16: - Rebase to alpine:3.5.
- 23.11.16: - Rebase to alpine:edge.
- 23.09.16: - Use QT5 dependencies (thanks bauerj).
- 10.09.16: - Add layer badges to README.
- 28.08.16: - Add badges to README.
- 10.08.16: - Rebase to xenial.
- 14.10.15: - Removed the webui, turned out to be to unstable for most usecases.
- 01.09.15: - Fixed mistake in README.
- 30.07.15: - Switched to internal baseimage, and fixed a bug with updating the webinterface.
- 06.07.15: - Enabled BLOWFISH encryption and added a (optional) webinterface, for the times you dont have access to your client.
linuxserver/quassel-web¶
Quassel-web is a web client for Quassel. Note that a Quassel-Core instance is required, we have a container available here.
Supported Architectures¶
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/quassel-web:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
By default this container webui will be available on https://$SERVER_IP:64443. To setup this container you can either use the envrionment variables we recommend or manually setup the configuration file by leaving out the QUASSEL_CORE environment variable among others. The configuration file using this method can be found at:
/config/settings-user.js
+ quassel-web - LinuxServer.io linuxserver/quassel-web¶
Quassel-web is a web client for Quassel. Note that a Quassel-Core instance is required, we have a container available here.
Supported Architectures¶
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/quassel-web:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
By default this container webui will be available on https://$SERVER_IP:64443. To setup this container you can either use the envrionment variables we recommend or manually setup the configuration file by leaving out the QUASSEL_CORE environment variable among others. The configuration file using this method can be found at:
Strict reverse proxies¶
This image uses a self-signed certificate by default. This naturally means the scheme is https. If you are using a reverse proxy which validates certificates, you need to disable this check for the container.
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)¶
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 64443Quassel-web https webui
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. QUASSEL_CORE=192.168.1.10specify the URL or IP address of your Quassel Core instance QUASSEL_PORT=4242specify the port of your Quassel Core instance URL_BASE=/quasselSpecify a url-base in reverse proxy setups ie. /quassel
Volume Mappings (-v)¶
Volume Function /configthis will store config on the docker host
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:
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:
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 quassel-web /bin/bash- To monitor the logs of the container in realtime:
docker logs -f quassel-web- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' quassel-web- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/quassel-web:latest
Versions¶
- 06.07.23: - Deprecate armhf. As announced here
- 13.02.23: - Rebasing to Alpine 3.17, migrate to s6v3.
- 12.02.22: - Rebasing to alpine 3.15.
- 01.06.20: - Rebasing to alpine 3.12.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 18.05.19: - Reconfigure environmental variable setup.
- 28.04.19: - Initial Release.
\ No newline at end of file
+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 quassel-web /bin/bash- To monitor the logs of the container in realtime:
docker logs -f quassel-web- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' quassel-web- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/quassel-web:latest
Versions¶
- 06.07.23: - Deprecate armhf. As announced here
- 13.02.23: - Rebasing to Alpine 3.17, migrate to s6v3.
- 12.02.22: - Rebasing to alpine 3.15.
- 01.06.20: - Rebasing to alpine 3.12.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 18.05.19: - Reconfigure environmental variable setup.
- 28.04.19: - Initial Release.
linuxserver/radarr¶
Radarr - A fork of Sonarr to work with movies à la Couchpotato.
Supported Architectures¶
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/radarr:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
| Tag | Available | Description |
|---|---|---|
| latest | ✅ | Stable Radarr releases |
| develop | ✅ | Radarr releases from their develop branch |
| nightly | ✅ | Radarr releases from their nightly branch |
| ## Application Setup |
Access the webui at <your-ip>:7878, for more information check out Radarr.
Media folders¶
We have set /movies and /downloads as optional paths, this is because it is the easiest way to get started. While easy to use, it has some drawbacks. Mainly losing the ability to hardlink (TL;DR a way for a file to exist in multiple places on the same file system while only consuming one file worth of space), or atomic move (TL;DR instant file moves, rather than copy+delete) files while processing content.
Use the optional paths if you dont understand, or dont want hardlinks/atomic moves.
The folks over at servarr.com wrote a good write-up on how to get started with this.
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)¶
---
+ radarr - LinuxServer.io linuxserver/radarr¶
Radarr - A fork of Sonarr to work with movies à la Couchpotato.
Supported Architectures¶
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/radarr:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
Tag Available Description latest ✅ Stable Radarr releases develop ✅ Radarr releases from their develop branch nightly ✅ Radarr releases from their nightly branch ## Application Setup
Access the webui at <your-ip>:7878, for more information check out Radarr.
Media folders¶
We have set /movies and /downloads as optional paths, this is because it is the easiest way to get started. While easy to use, it has some drawbacks. Mainly losing the ability to hardlink (TL;DR a way for a file to exist in multiple places on the same file system while only consuming one file worth of space), or atomic move (TL;DR instant file moves, rather than copy+delete) files while processing content.
Use the optional paths if you dont understand, or dont want hardlinks/atomic moves.
The folks over at servarr.com wrote a good write-up on how to get started with this.
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)¶
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 7878The port for the Radarr webinterface
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configDatabase and Radarr configs /moviesLocation of Movie library on disk (See note in Application setup) /downloadsLocation of download managers output directory (See note in Application setup)
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:
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:
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 radarr /bin/bash- To monitor the logs of the container in realtime:
docker logs -f radarr- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' radarr- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/radarr:latest
Versions¶
- 06.06.23: - Rebase master to Alpine 3.18, deprecate armhf as per https://www.linuxserver.io/armhf.
- 17.01.23: - Rebase master branch to Alpine 3.17, migrate to s6v3.
- 06.06.22: - Rebase master branch to Alpine 3.15.
- 20.02.22: - Rebase develop branch to Alpine.
- 04.02.22: - Rebase nightly branch to Alpine and deprecate nightly-alpine branch.
- 27.12.21: - Add nightly-alpine branch.
- 17.10.21: - Remove
UMASK_SET. - 08.05.21: - Make the paths clearer to the user
- 17.01.21: - Deprecate
UMASK_SET in favor of UMASK in baseimage, see above for more information. - 11.30.20: - Publish
develop tag. - 11.28.20: - Switch to v3 .NET CORE builds (no more mono,
5.14 tag is deprecated). Rebase to Focal (for issues on arm32v7, see here). - 05.04.20: - Move app to /app.
- 01.08.19: - Rebase to Linuxserver LTS mono version.
- 13.06.19: - Add env variable for setting umask.
- 10.05.19: - Rebase to Bionic.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 09.09.18: - Add pipeline build process.
- 24.02.18: - Add nightly branch.
- 06.02.18: - Radarr repo changed owner.
- 15.12.17: - Fix continuation lines.
- 17.04.17: - Switch to using inhouse mono baseimage, adds python also.
- 13.04.17: - Switch to official mono repository.
- 10.01.17: - Initial Release.
\ No newline at end of file
+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 radarr /bin/bash- To monitor the logs of the container in realtime:
docker logs -f radarr- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' radarr- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/radarr:latest
Versions¶
- 06.06.23: - Rebase master to Alpine 3.18, deprecate armhf as per https://www.linuxserver.io/armhf.
- 17.01.23: - Rebase master branch to Alpine 3.17, migrate to s6v3.
- 06.06.22: - Rebase master branch to Alpine 3.15.
- 20.02.22: - Rebase develop branch to Alpine.
- 04.02.22: - Rebase nightly branch to Alpine and deprecate nightly-alpine branch.
- 27.12.21: - Add nightly-alpine branch.
- 17.10.21: - Remove
UMASK_SET. - 08.05.21: - Make the paths clearer to the user
- 17.01.21: - Deprecate
UMASK_SETin favor of UMASK in baseimage, see above for more information. - 11.30.20: - Publish
developtag. - 11.28.20: - Switch to v3 .NET CORE builds (no more mono,
5.14tag is deprecated). Rebase to Focal (for issues on arm32v7, see here). - 05.04.20: - Move app to /app.
- 01.08.19: - Rebase to Linuxserver LTS mono version.
- 13.06.19: - Add env variable for setting umask.
- 10.05.19: - Rebase to Bionic.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 09.09.18: - Add pipeline build process.
- 24.02.18: - Add nightly branch.
- 06.02.18: - Radarr repo changed owner.
- 15.12.17: - Fix continuation lines.
- 17.04.17: - Switch to using inhouse mono baseimage, adds python also.
- 13.04.17: - Switch to official mono repository.
- 10.01.17: - Initial Release.
linuxserver/raneto¶
Raneto - is an open source Knowledgebase platform that uses static Markdown files to power your Knowledgebase.
Supported Architectures¶
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/raneto:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
Access the webui at http://
The default username and password is admin/password
This application can only be configured through file storage the web interface is only for editing Markdown files. You need to understand the following paths and the role they play for the application:
- /config/config.default.js - Main configuration file to setup your user, site name, etc.
- /config/content - All of your Markdown files go here more info.
- /config/images - This folder will serve content on http://
:3000/images/ .png you can put anything in here but it is specifically for image files so you can embed them in your Markdown files without using external hosting.
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)¶
---
+ raneto - LinuxServer.io linuxserver/raneto¶
Raneto - is an open source Knowledgebase platform that uses static Markdown files to power your Knowledgebase.
Supported Architectures¶
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/raneto:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
Access the webui at http://:3000
The default username and password is admin/password
This application can only be configured through file storage the web interface is only for editing Markdown files. You need to understand the following paths and the role they play for the application:
- /config/config.default.js - Main configuration file to setup your user, site name, etc.
- /config/content - All of your Markdown files go here more info.
- /config/images - This folder will serve content on http://
:3000/images/.png you can put anything in here but it is specifically for image files so you can embed them in your Markdown files without using external hosting.
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)¶
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 3000The port for the Raneto web interface
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configRaneto config and Markdown files
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:
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:
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 raneto /bin/bash- To monitor the logs of the container in realtime:
docker logs -f raneto- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' raneto- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/raneto:latest
Versions¶
- 12.07.23: - Rebase to Alpine 3.18.
- 01.07.23: - Deprecate armhf. As announced here
- 21.04.23: - Fix for upstream changes.
- 18.01.23: - Rebase to Alpine 3.17, migrate to s6v3.
- 10.08.22: - Rebasing to alpine 3.15.
- 23.01.21: - Rebasing to alpine 3.13.
- 02.06.20: - Rebasing to alpine 3.11.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 01.06.19: - Initial Release.
\ No newline at end of file
+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 raneto /bin/bash- To monitor the logs of the container in realtime:
docker logs -f raneto- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' raneto- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/raneto:latest
Versions¶
- 12.07.23: - Rebase to Alpine 3.18.
- 01.07.23: - Deprecate armhf. As announced here
- 21.04.23: - Fix for upstream changes.
- 18.01.23: - Rebase to Alpine 3.17, migrate to s6v3.
- 10.08.22: - Rebasing to alpine 3.15.
- 23.01.21: - Rebasing to alpine 3.13.
- 02.06.20: - Rebasing to alpine 3.11.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 01.06.19: - Initial Release.
linuxserver/rdesktop¶
Rdesktop - Containers containing full desktop environments in many popular flavors for Alpine, Ubuntu, Arch, and Fedora accessible via RDP.
Supported Architectures¶
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/rdesktop:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
| Tag | Available | Description |
|---|---|---|
| latest | ✅ | XFCE Alpine |
| ubuntu-xfce | ✅ | XFCE Ubuntu |
| fedora-xfce | ✅ | XFCE Fedora |
| arch-xfce | ✅ | XFCE Arch |
| alpine-kde | ✅ | KDE Alpine |
| ubuntu-kde | ✅ | KDE Ubuntu |
| fedora-kde | ✅ | KDE Fedora |
| arch-kde | ✅ | KDE Arch |
| alpine-mate | ✅ | MATE Alpine |
| ubuntu-mate | ✅ | MATE Ubuntu |
| fedora-mate | ✅ | MATE Fedora |
| arch-mate | ✅ | MATE Arch |
| alpine-i3 | ✅ | i3 Alpine |
| ubuntu-i3 | ✅ | i3 Ubuntu |
| fedora-i3 | ✅ | i3 Fedora |
| arch-i3 | ✅ | i3 Arch |
| alpine-openbox | ✅ | Openbox Alpine |
| ubuntu-openbox | ✅ | Openbox Ubuntu |
| fedora-openbox | ✅ | Openbox Fedora |
| arch-openbox | ✅ | Openbox Arch |
| alpine-icewm | ✅ | IceWM Alpine |
| ubuntu-icewm | ✅ | IceWM Ubuntu |
| fedora-icewm | ✅ | IceWM Fedora |
| arch-icewm | ✅ | IceWM Arch |
| ## Application Setup |
The Default USERNAME and PASSWORD is: abc/abc
Unlike our other containers these Desktops are not designed to be upgraded by Docker, you will keep your home directoy but anything you installed system level will be lost if you upgrade an existing container. To keep packages up to date instead use Ubuntu's own apt, Alpine's apk, Fedora's dnf, or Arch's pacman program
You will need a Remote Desktop client to access this container Wikipedia List, by default it listens on 3389, but you can change that port to whatever you wish on the host side IE 3390:3389. The first thing you should do when you login to the container is to change the abc users password by issuing the passwd command.
Modern GUI desktop apps (including some flavors terminals) have issues with the latest Docker and syscall compatibility, you can use Docker with the --security-opt seccomp=unconfined setting to allow these syscalls or try podman as they have updated their codebase to support them
If you ever lose your password you can always reset it by execing into the container as root:
docker exec -it rdesktop passwd abc
+ rdesktop - LinuxServer.io linuxserver/rdesktop¶
Rdesktop - Containers containing full desktop environments in many popular flavors for Alpine, Ubuntu, Arch, and Fedora accessible via RDP.
Supported Architectures¶
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/rdesktop:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
Tag Available Description latest ✅ XFCE Alpine ubuntu-xfce ✅ XFCE Ubuntu fedora-xfce ✅ XFCE Fedora arch-xfce ✅ XFCE Arch alpine-kde ✅ KDE Alpine ubuntu-kde ✅ KDE Ubuntu fedora-kde ✅ KDE Fedora arch-kde ✅ KDE Arch alpine-mate ✅ MATE Alpine ubuntu-mate ✅ MATE Ubuntu fedora-mate ✅ MATE Fedora arch-mate ✅ MATE Arch alpine-i3 ✅ i3 Alpine ubuntu-i3 ✅ i3 Ubuntu fedora-i3 ✅ i3 Fedora arch-i3 ✅ i3 Arch alpine-openbox ✅ Openbox Alpine ubuntu-openbox ✅ Openbox Ubuntu fedora-openbox ✅ Openbox Fedora arch-openbox ✅ Openbox Arch alpine-icewm ✅ IceWM Alpine ubuntu-icewm ✅ IceWM Ubuntu fedora-icewm ✅ IceWM Fedora arch-icewm ✅ IceWM Arch ## Application Setup
The Default USERNAME and PASSWORD is: abc/abc
Unlike our other containers these Desktops are not designed to be upgraded by Docker, you will keep your home directoy but anything you installed system level will be lost if you upgrade an existing container. To keep packages up to date instead use Ubuntu's own apt, Alpine's apk, Fedora's dnf, or Arch's pacman program
You will need a Remote Desktop client to access this container Wikipedia List, by default it listens on 3389, but you can change that port to whatever you wish on the host side IE 3390:3389. The first thing you should do when you login to the container is to change the abc users password by issuing the passwd command.
Modern GUI desktop apps (including some flavors terminals) have issues with the latest Docker and syscall compatibility, you can use Docker with the --security-opt seccomp=unconfined setting to allow these syscalls or try podman as they have updated their codebase to support them
If you ever lose your password you can always reset it by execing into the container as root:
By default we perform all logic for the abc user and we reccomend using that user only in the container, but new users can be added as long as there is a startwm.sh executable script in their home directory. All of these containers are configured with passwordless sudo, we make no efforts to secure or harden these containers and we do not reccomend ever publishing their ports to the public Internet. Hardware Acceleration (Ubuntu Container Only)¶
Many desktop application will need access to a GPU to function properly and even some Desktop Environments have compisitor effects that will not function without a GPU. This is not a hard requirement and all base images will function without a video device mounted into the container.
Intel/ATI/AMD¶
To leverage hardware acceleration you will need to mount /dev/dri video device inside of the conainer.
We will automatically ensure the abc user inside of the container has the proper permissions to access this device. Nvidia¶
Hardware acceleration users for Nvidia will need to install the container runtime provided by Nvidia on their host, instructions can be found here: https://github.com/NVIDIA/nvidia-docker
We automatically add the necessary environment variable that will utilise all the features available on a GPU on the host. Once nvidia-docker is installed on your host you will need to re/create the docker container with the nvidia container runtime --runtime=nvidia and add an environment variable -e NVIDIA_VISIBLE_DEVICES=all (can also be set to a specific gpu's UUID, this can be discovered by running nvidia-smi --query-gpu=gpu_name,gpu_uuid --format=csv ). NVIDIA automatically mounts the GPU and drivers from your host into the container.
Arm Devices¶
Best effort is made to install tools to allow mounting in /dev/dri on Arm devices. In most cases if /dev/dri exists on the host it should just work. If running a Raspberry Pi 4 be sure to enable dtoverlay=vc4-fkms-v3d in your usercfg.txt.
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)¶
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 3389RDP access port
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /var/run/docker.sockDocker Socket on the system, if you want to use Docker in the container /configabc users home directory
Device Mappings (--device)¶
Parameter Function /dev/driAdd this for GL support (Linux hosts only)
Miscellaneous Options¶
Parameter Function --shm-size=We set this to 1 gig to prevent modern web browsers from crashing --security-opt seccomp=unconfinedFor Docker Engine only, many modern gui apps need this to function as syscalls are unkown to Docker
Environment variables from files (Docker secrets)¶
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
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:
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 rdesktop /bin/bash- To monitor the logs of the container in realtime:
docker logs -f rdesktop- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' rdesktop- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/rdesktop:latest
Versions¶
- 18.05.23: - Rebase all Alpine images to 3.18, deprecate armhf.
- 27.10.22: - Rebase all Ubuntu images to Jammy 22.04.
- 26.10.22: - Rebase Alpine xfce to 3.16, migrate to s6v3.
- 05.03.22: - Organize tags differently to run Ubuntu at latest LTS, make Alpine latest, add docs about GPU accel.
- 05.05.21: - Reduce default packages to their flavor specific basics.
- 05.04.21: - Add Alpine flavor.
- 06.04.20: - Start PulseAudio in images to support audio
- 28.02.20: - Initial Releases
\ No newline at end of file
+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 rdesktop /bin/bash- To monitor the logs of the container in realtime:
docker logs -f rdesktop- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' rdesktop- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/rdesktop:latest
Versions¶
- 18.05.23: - Rebase all Alpine images to 3.18, deprecate armhf.
- 27.10.22: - Rebase all Ubuntu images to Jammy 22.04.
- 26.10.22: - Rebase Alpine xfce to 3.16, migrate to s6v3.
- 05.03.22: - Organize tags differently to run Ubuntu at latest LTS, make Alpine latest, add docs about GPU accel.
- 05.05.21: - Reduce default packages to their flavor specific basics.
- 05.04.21: - Add Alpine flavor.
- 06.04.20: - Start PulseAudio in images to support audio
- 28.02.20: - Initial Releases
linuxserver/readarr¶
Readarr - Book Manager and Automation (Sonarr for Ebooks)
Supported Architectures¶
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/readarr:nightly 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ✅ | arm32v7-<version tag> |
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
| Tag | Available | Description |
|---|---|---|
| latest | ❌ | |
| nightly | ✅ | Nightly Readarr releases |
Application Setup¶
Access the webui at <your-ip>:8787, for more information check out Readarr.
Media folders¶
We have set /books and /downloads as optional paths, this is because it is the easiest way to get started. While easy to use, it has some drawbacks. Mainly losing the ability to hardlink (TL;DR a way for a file to exist in multiple places on the same file system while only consuming one file worth of space), or atomic move (TL;DR instant file moves, rather than copy+delete) files while processing content.
Use the optional paths if you dont understand, or dont want hardlinks/atomic moves.
The folks over at servarr.com wrote a good write-up on how to get started with this.
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)¶
---
+ readarr - LinuxServer.io linuxserver/readarr¶
Readarr - Book Manager and Automation (Sonarr for Ebooks)
Supported Architectures¶
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/readarr:nightly 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ✅ arm32v7-<version tag>
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
Tag Available Description latest ❌ nightly ✅ Nightly Readarr releases
Application Setup¶
Access the webui at <your-ip>:8787, for more information check out Readarr.
Media folders¶
We have set /books and /downloads as optional paths, this is because it is the easiest way to get started. While easy to use, it has some drawbacks. Mainly losing the ability to hardlink (TL;DR a way for a file to exist in multiple places on the same file system while only consuming one file worth of space), or atomic move (TL;DR instant file moves, rather than copy+delete) files while processing content.
Use the optional paths if you dont understand, or dont want hardlinks/atomic moves.
The folks over at servarr.com wrote a good write-up on how to get started with this.
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)¶
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 8787The port for the Readarr webinterface
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Europe/LondonSpecify a timezone to use EG Europe/London, this is required for Readarr
Volume Mappings (-v)¶
Volume Function /configDatabase and Readarr configs /booksLocation of Book library on disk (See note in Application setup) /downloadsLocation of download managers output directory (See note in Application setup)
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:
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:
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 readarr /bin/bash- To monitor the logs of the container in realtime:
docker logs -f readarr- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' readarr- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/readarr:nightly
Versions¶
- 21.01.22: - Remove chromaprint as it's no longer a required dependency.
- 01.01.22: - Add chromaprint for audio fingerprinting.
- 28.07.21: - Initial Release.
\ No newline at end of file
+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 readarr /bin/bash- To monitor the logs of the container in realtime:
docker logs -f readarr- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' readarr- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/readarr:nightly
Versions¶
- 21.01.22: - Remove chromaprint as it's no longer a required dependency.
- 01.01.22: - Add chromaprint for audio fingerprinting.
- 28.07.21: - Initial Release.
Contact information:-¶
| Type | Address/Details |
|---|---|
| Discord | Discord |
| Forum | Linuserver.io forum |
| IRC | freenode at #linuxserver.io more information at:- IRC |
| Podcast | Covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation! Linuxserver.io Podcast |
The LinuxServer.io team brings you another image release featuring :-
- regular and timely application updates
- easy user mappings
- custom base image with s6 overlay
- weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
- security updates
lsiodev/readme-sync¶
Utility to copy README.md from a given github.com repository to a given dockerhub.com repository.
Usage¶
docker run --rm=true \
+ readme-sync - LinuxServer.io
Contact information:-¶
Type Address/Details Discord Discord Forum Linuserver.io forum IRC freenode at #linuxserver.io more information at:- IRC Podcast Covers everything to do with getting the most from your Linux Server plus a focus on all things Docker and containerisation! Linuxserver.io Podcast
The LinuxServer.io team brings you another image release featuring :-
- regular and timely application updates
- easy user mappings
- custom base image with s6 overlay
- weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
- security updates
lsiodev/readme-sync¶
Utility to copy README.md from a given github.com repository to a given dockerhub.com repository.
Usage¶
docker run --rm=true \
-e DOCKERHUB_USERNAME=<USERNAME> \
-e DOCKERHUB_PASSWORD=<PASSWORD> \
-e GIT_REPOSITORY=<GITHUB REPO> \
-e DOCKER_REPOSITORY=<DOCKERHUB REPO> \
-e GIT_BRANCH=<GITHUB BRANCH> \
lsiodev/readme-sync bash -c 'node sync'
-
Parameters¶
The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side. For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container. So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.
Parameter Function -e DOCKERHUB_USERNAMEyour dockerhub username -e DOCKERHUB_PASSWORDyour dockerhub password -e GIT_REPOSITORYgithub repository, i.e. linuxserver/docker-readme-sync -e DOCKER_REPOSITORYdockerhub repository, i.e. lsiodev/docker-readme-sync -e GIT_BRANCHgithub repository branch, optional (default: master)
It is based on alpine and is not meant to run as a service. The sync is performed and the command exits.
Versions¶
Date Changes 13.01.21 Use ghcr baseimages. Fall back to external folder for readme lite. 28.07.20 Rebase to alpine 3.12. 20.08.18 Rebase to alpine 3.8. 28.02.18 convert repo to use node.js implementation. 17.11.17 add github branch support. 16.10.16 merge ruby app. 11.10.16 Initial development release.
\ No newline at end of file
+
Parameters¶
The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side. For example with a port -p external:internal - what this shows is the port mapping from internal to external of the container. So -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 http://192.168.x.x:8080 would show you what's running INSIDE the container on port 80.
| Parameter | Function |
|---|---|
-e DOCKERHUB_USERNAME | your dockerhub username |
-e DOCKERHUB_PASSWORD | your dockerhub password |
-e GIT_REPOSITORY | github repository, i.e. linuxserver/docker-readme-sync |
-e DOCKER_REPOSITORY | dockerhub repository, i.e. lsiodev/docker-readme-sync |
-e GIT_BRANCH | github repository branch, optional (default: master) |
It is based on alpine and is not meant to run as a service. The sync is performed and the command exits.
Versions¶
| Date | Changes |
|---|---|
| 13.01.21 | Use ghcr baseimages. Fall back to external folder for readme lite. |
| 28.07.20 | Rebase to alpine 3.12. |
| 20.08.18 | Rebase to alpine 3.8. |
| 28.02.18 | convert repo to use node.js implementation. |
| 17.11.17 | add github branch support. |
| 16.10.16 | merge ruby app. |
| 11.10.16 | Initial development release. |
linuxserver/remmina¶
Remmina is a remote desktop client written in GTK, aiming to be useful for system administrators and travellers, who need to work with lots of remote computers in front of either large or tiny screens. Remmina supports multiple network protocols, in an integrated and consistent user interface. Currently RDP, VNC, SPICE, NX, XDMCP, SSH and EXEC are supported.
Supported Architectures¶
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/remmina:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
The application can be accessed at:
- http://yourhost:3000/
- https://yourhost:3001/
Options in all KasmVNC based GUI containers¶
This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.
Optional environment variables¶
| Variable | Description |
|---|---|
| CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default 3000. |
| CUSTOM_HTTPS_PORT | Internal port the container listens on for https if it needs to be swapped from the default 3001. |
| CUSTOM_USER | HTTP Basic auth username, abc is default. |
| PASSWORD | HTTP Basic auth password, abc is default. If unset there will be no auth |
| SUBFOLDER | Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/ |
| TITLE | The page title displayed on the web browser, default "KasmVNC Client". |
| FM_HOME | This is the home directory (landing) for the file manager, default "/config". |
| START_DOCKER | If set to false a container with privilege will not automatically start the DinD Docker setup. |
| DRINODE | If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE /dev/dri/renderD128 |
Optional run configurations¶
| Variable | Description |
|---|---|
--privileged | Will start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE -v /home/user/docker-data:/var/lib/docker. |
-v /var/run/docker.sock:/var/run/docker.sock | Mount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. |
--device /dev/dri:/dev/dri | Mount a GPU into the container, this can be used in conjunction with the DRINODE environment variable to leverage a host video card for GPU accelerated appplications. Only Open Source drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau) |
Lossless mode¶
This container is capable of delivering a true lossless image at a high framerate to your web browser by changing the Stream Quality preset to "Lossless", more information here. In order to use this mode from a non localhost endpoint the HTTPS port on 3001 needs to be used. If using a reverse proxy to port 3000 specific headers will need to be set as outlined here.
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)¶
---
+ remmina - LinuxServer.io linuxserver/remmina¶
Remmina is a remote desktop client written in GTK, aiming to be useful for system administrators and travellers, who need to work with lots of remote computers in front of either large or tiny screens. Remmina supports multiple network protocols, in an integrated and consistent user interface. Currently RDP, VNC, SPICE, NX, XDMCP, SSH and EXEC are supported.
Supported Architectures¶
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/remmina:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
The application can be accessed at:
- http://yourhost:3000/
- https://yourhost:3001/
Options in all KasmVNC based GUI containers¶
This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.
Optional environment variables¶
Variable Description CUSTOM_PORT Internal port the container listens on for http if it needs to be swapped from the default 3000. CUSTOM_HTTPS_PORT Internal port the container listens on for https if it needs to be swapped from the default 3001. CUSTOM_USER HTTP Basic auth username, abc is default. PASSWORD HTTP Basic auth password, abc is default. If unset there will be no auth SUBFOLDER Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/ TITLE The page title displayed on the web browser, default "KasmVNC Client". FM_HOME This is the home directory (landing) for the file manager, default "/config". START_DOCKER If set to false a container with privilege will not automatically start the DinD Docker setup. DRINODE If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE /dev/dri/renderD128
Optional run configurations¶
Variable Description --privilegedWill start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE -v /home/user/docker-data:/var/lib/docker. -v /var/run/docker.sock:/var/run/docker.sockMount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. --device /dev/dri:/dev/driMount a GPU into the container, this can be used in conjunction with the DRINODE environment variable to leverage a host video card for GPU accelerated appplications. Only Open Source drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau)
Lossless mode¶
This container is capable of delivering a true lossless image at a high framerate to your web browser by changing the Stream Quality preset to "Lossless", more information here. In order to use this mode from a non localhost endpoint the HTTPS port on 3001 needs to be used. If using a reverse proxy to port 3000 specific headers will need to be set as outlined here.
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)¶
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 3000Remmina desktop gui. 3001Remmina desktop gui HTTPS.
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configUsers home directory in the container, stores program 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:
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:
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 remmina /bin/bash- To monitor the logs of the container in realtime:
docker logs -f remmina- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' remmina- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/remmina:latest
Versions¶
- 18.03.23: - Rebase to KasmVNC base image.
- 16.12.22: - Rebase to Jammy. Drop nx, xdmcp plugins due to lack of packages. Add Kiosk, Secret, x2go plugins.
- 19.06.22: - Rebase to Focal. Drop Telepathy plugin due to lack of packages.
- 27.03.20: - Initial release.
\ No newline at end of file
+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 remmina /bin/bash- To monitor the logs of the container in realtime:
docker logs -f remmina- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' remmina- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/remmina:latest
Versions¶
- 18.03.23: - Rebase to KasmVNC base image.
- 16.12.22: - Rebase to Jammy. Drop nx, xdmcp plugins due to lack of packages. Add Kiosk, Secret, x2go plugins.
- 19.06.22: - Rebase to Focal. Drop Telepathy plugin due to lack of packages.
- 27.03.20: - Initial release.
DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. The upstream dev has ended development.
linuxserver/requestrr¶
Requestrr is a chatbot used to simplify using services like Sonarr/Radarr/Ombi via the use of chat.
Supported Architectures¶
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/requestrr:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ✅ | arm32v7-<version tag> |
Application Setup¶
Access the webui at <your-ip>:4545, for more information check out Requestrr.
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)¶
---
+ requestrr - LinuxServer.io DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. The upstream dev has ended development.
linuxserver/requestrr¶
Requestrr is a chatbot used to simplify using services like Sonarr/Radarr/Ombi via the use of chat.
Supported Architectures¶
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/requestrr:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ✅ arm32v7-<version tag>
Application Setup¶
Access the webui at <your-ip>:4545, for more information check out Requestrr.
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)¶
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 4545web gui
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Europe/LondonSpecify a timezone to use EG Europe/London
Volume Mappings (-v)¶
Volume Function /configContains all relevant configuration files.
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:
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:
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 requestrr /bin/bash- To monitor the logs of the container in realtime:
docker logs -f requestrr- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' requestrr- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/requestrr:latest
Versions¶
- 20.12.21: - Deprecate.
- 27.09.21: - Allow app to write to tmp folder.
- 21.02.21: - Initial Release.
\ No newline at end of file
+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 requestrr /bin/bash- To monitor the logs of the container in realtime:
docker logs -f requestrr- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' requestrr- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/requestrr:latest
Versions¶
- 20.12.21: - Deprecate.
- 27.09.21: - Allow app to write to tmp folder.
- 21.02.21: - Initial Release.
linuxserver/resilio-sync¶
Resilio-sync (formerly BitTorrent Sync) uses the BitTorrent protocol to sync files and folders between all of your devices. There are both free and paid versions, this container supports both. There is an official sync image but we created this one as it supports user mapping to simplify permissions for volumes.
Supported Architectures¶
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/resilio-sync:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
- Webui is at
<your-ip>:8888, for account creation and configuration. - More info on setup at Resilio Sync
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)¶
---
+ resilio-sync - LinuxServer.io linuxserver/resilio-sync¶
Resilio-sync (formerly BitTorrent Sync) uses the BitTorrent protocol to sync files and folders between all of your devices. There are both free and paid versions, this container supports both. There is an official sync image but we created this one as it supports user mapping to simplify permissions for volumes.
Supported Architectures¶
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/resilio-sync:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
- Webui is at
<your-ip>:8888, for account creation and configuration. - More info on setup at Resilio Sync
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)¶
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 8888WebUI 55555Sync Port.
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configWhere resilio-sync should store its config file. /downloadsFolder for downloads/cache. /syncSync folders root.
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:
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:
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 resilio-sync /bin/bash- To monitor the logs of the container in realtime:
docker logs -f resilio-sync- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' resilio-sync- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/resilio-sync:latest
Versions¶
- 03.07.23: - Deprecate armhf. As announced here
- 14.12.22: - Rebase to Jammy, migrate to s6v3.
- 03.10.21: - Use upstream apt repo to install. Rebase to focal.
- 20.01.21: - Deprecate
UMASK_SET in favor of UMASK in baseimage, see above for more information. - 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 11.02.19: - Rebase to bionic, add pipeline logic and multi arch.
- 05.02.18: - Add downloads volume mount.
- 28.01.18: - Add /sync to dir whitelist.
- 26.01.18: - Use variable for arch to bring in line with armhf arch repo.
- 15.12.17: - Fix continuation lines.
- 02.06.17: - Rebase to ubuntu xenial, alpine linux no longer works with resilio.
- 22.05.17: - Add variable for user defined umask.
- 14.05.17: - Use fixed version instead of latest, while 2.5.0 is broken on non glibc (alpine).
- 08.02.17: - Rebase to alpine 3.5.
- 02.11.16: - Initial Release.
\ No newline at end of file
+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 resilio-sync /bin/bash- To monitor the logs of the container in realtime:
docker logs -f resilio-sync- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' resilio-sync- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/resilio-sync:latest
Versions¶
- 03.07.23: - Deprecate armhf. As announced here
- 14.12.22: - Rebase to Jammy, migrate to s6v3.
- 03.10.21: - Use upstream apt repo to install. Rebase to focal.
- 20.01.21: - Deprecate
UMASK_SETin favor of UMASK in baseimage, see above for more information. - 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 11.02.19: - Rebase to bionic, add pipeline logic and multi arch.
- 05.02.18: - Add downloads volume mount.
- 28.01.18: - Add /sync to dir whitelist.
- 26.01.18: - Use variable for arch to bring in line with armhf arch repo.
- 15.12.17: - Fix continuation lines.
- 02.06.17: - Rebase to ubuntu xenial, alpine linux no longer works with resilio.
- 22.05.17: - Add variable for user defined umask.
- 14.05.17: - Use fixed version instead of latest, while 2.5.0 is broken on non glibc (alpine).
- 08.02.17: - Rebase to alpine 3.5.
- 02.11.16: - Initial Release.
linuxserver/rsnapshot¶
Rsnapshot is a filesystem snapshot utility based on rsync. rsnapshot makes it easy to make periodic snapshots of local machines, and remote machines over ssh. The code makes extensive use of hard links whenever possible, to greatly reduce the disk space required."
Supported Architectures¶
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/rsnapshot:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
IMPORTANT NOTES:¶
After starting the container you will need to edit /config/rsnapshot.conf.
SNAPSHOT ROOT DIRECTORY¶
rsnapshot is configured to backup data to the /.snapshots volume by default. This can be changed in the config, but be sure you mount a volume to the container to match.
BACKUP LEVELS / INTERVALS¶
rsnapshot retains backups based on configurations in this section. Please see the rsnapshot readme for more information.
BACKUP POINTS¶
rsnapshot is configured to backup data from the /data volume by default. This can be changed in the config, but be sure you mount a volume to the container to match.
cron¶
You will then need to edit /config/crontabs/root to set cron jobs to run rsnapshot. By default no cron jobs are enabled. Examples are includes based on information from the rsnapshot readme.
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)¶
---
+ rsnapshot - LinuxServer.io linuxserver/rsnapshot¶
Rsnapshot is a filesystem snapshot utility based on rsync. rsnapshot makes it easy to make periodic snapshots of local machines, and remote machines over ssh. The code makes extensive use of hard links whenever possible, to greatly reduce the disk space required."
Supported Architectures¶
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/rsnapshot:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
IMPORTANT NOTES:¶
After starting the container you will need to edit /config/rsnapshot.conf.
SNAPSHOT ROOT DIRECTORY¶
rsnapshot is configured to backup data to the /.snapshots volume by default. This can be changed in the config, but be sure you mount a volume to the container to match.
BACKUP LEVELS / INTERVALS¶
rsnapshot retains backups based on configurations in this section. Please see the rsnapshot readme for more information.
BACKUP POINTS¶
rsnapshot is configured to backup data from the /data volume by default. This can be changed in the config, but be sure you mount a volume to the container to match.
cron¶
You will then need to edit /config/crontabs/root to set cron jobs to run rsnapshot. By default no cron jobs are enabled. Examples are includes based on information from the rsnapshot readme.
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)¶
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
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configContains all relevant configuration files. /.snapshotsStorage location for all snapshots. /dataStorage location for data to be backed up.
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:
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:
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 rsnapshot /bin/bash- To monitor the logs of the container in realtime:
docker logs -f rsnapshot- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' rsnapshot- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/rsnapshot:latest
Versions¶
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 02.03.23: - Split cron into separate init step and set crontab permissions.
- 15.12.22: - Rebase to alpine 3.17.
- 11.10.22: - Rebase to alpine 3.16, migrate to s6v3.
- 10.10.21: - Rebase to alpine 3.14.
- 20.08.20: - Initial Release.
\ No newline at end of file
+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 rsnapshot /bin/bash- To monitor the logs of the container in realtime:
docker logs -f rsnapshot- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' rsnapshot- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/rsnapshot:latest
Versions¶
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 02.03.23: - Split cron into separate init step and set crontab permissions.
- 15.12.22: - Rebase to alpine 3.17.
- 11.10.22: - Rebase to alpine 3.16, migrate to s6v3.
- 10.10.21: - Rebase to alpine 3.14.
- 20.08.20: - Initial Release.
DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated.
linuxserver/rutorrent¶
Rutorrent is a popular rtorrent client with a webui for ease of use.
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/rutorrent 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 | amd64-latest |
| arm64 | arm64v8-latest |
| armhf | arm32v7-latest |
Usage¶
Here are some example snippets to help you get started creating a container from this image.
docker-compose (recommended)¶
Compatible with docker-compose v2 schemas.
---
+ rutorrent - LinuxServer.io DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated.
linuxserver/rutorrent¶
Rutorrent is a popular rtorrent client with a webui for ease of use.
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/rutorrent 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 amd64-latest arm64 arm64v8-latest armhf arm32v7-latest
Usage¶
Here are some example snippets to help you get started creating a container from this image.
docker-compose (recommended)¶
Compatible with docker-compose v2 schemas.
If after updating you see an error about connecting to rtorrent in the webui, remove or comment out these lines in /config/rtorrent/rtorrent.rc ,whatever value is set, yes or no. Just setting them to no will still cause the error..
To add plugins, create a plugins folder in your /config directory and add your plugin folders. Ensure proper user and group ownership is set once you add the directories. To add themes, create a themes folder in your /config directory and add your theme folders. Ensure proper user and group ownership is set once you add the directories. 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 rutorrent /bin/bash- To monitor the logs of the container in realtime:
docker logs -f rutorrent- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' rutorrent- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/rutorrent
Versions¶
- 25.03.22: - Deprecated. Please migrate to crazy-max's image.
- 02.06.20: - Rebasing to alpine 3.12.
- 29.02.20: - Update readme for pex/dht.
- 28.06.19: - Rebasing to alpine 3.10.
- 20.05.19: - Shift to building from official releases instead of commits.
- 13.05.19: - Add libffi and openssl.
- 07.05.19: - Add cloudscraper pip package.
- 11.04.19: - Fix warnings in webui by adding python3, procps and pip packages.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebasing to alpine 3.9.
- 03.11.18: - Add pipeline and multi arch logic to repo.
- 27.08.18: - Add bind tools package.
- 22.08.18: - Rebase to alpine 3.8.
- 08.12.17: - Rebase to alpine 3.7, add sox package.
- 28.10.17: - Mediainfo moved from testing to community repo.
- 09.10.17: - Use repo version of mediainfo to shorten build time.
- 28.05.17: - Fix permissions on secondary temp folder of nginx.
- 26.05.17: - Rebase to alpine 3.6.
- 03.05.17: - Fix log permissions.
- 18.03.17: - Note in readme about disabling dht in some circumstances.
- 24.02.17: - Patch a source file to quash rss https bug.
- 29.01.17: - Rebase to alpine 3.5.
- 20.11.16: - Add php7-mbstring package, bump mediainfo to 0.7.90.
- 14.10.16: - Add version layer information.
- 04.10.16: - Remove redundant sessions folder.
- 30.09.16: - Fix umask.
- 21.09.16: - Bump mediainfo, reorg dockerfile, add full wget package.
- 09.09.16: - Add layer badges to README.
- 28.08.16: - Add badges to README, bump mediainfo version to 0.7.87.
- 07.08.16: - Perms fix on nginx tmp folder, also exposed php.ini for editing by use in /config/php.
- 26.07.16: - Rebase to alpine.
- 08.03.16: - Initial Release.
\ No newline at end of file
+plugins folder in your /config directory and add your plugin folders. Ensure proper user and group ownership is set once you add the directories. To add themes, create a themes folder in your /config directory and add your theme folders. Ensure proper user and group ownership is set once you add the directories. 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 rutorrent /bin/bash- To monitor the logs of the container in realtime:
docker logs -f rutorrent- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' rutorrent- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/rutorrent
Versions¶
- 25.03.22: - Deprecated. Please migrate to crazy-max's image.
- 02.06.20: - Rebasing to alpine 3.12.
- 29.02.20: - Update readme for pex/dht.
- 28.06.19: - Rebasing to alpine 3.10.
- 20.05.19: - Shift to building from official releases instead of commits.
- 13.05.19: - Add libffi and openssl.
- 07.05.19: - Add cloudscraper pip package.
- 11.04.19: - Fix warnings in webui by adding python3, procps and pip packages.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebasing to alpine 3.9.
- 03.11.18: - Add pipeline and multi arch logic to repo.
- 27.08.18: - Add bind tools package.
- 22.08.18: - Rebase to alpine 3.8.
- 08.12.17: - Rebase to alpine 3.7, add sox package.
- 28.10.17: - Mediainfo moved from testing to community repo.
- 09.10.17: - Use repo version of mediainfo to shorten build time.
- 28.05.17: - Fix permissions on secondary temp folder of nginx.
- 26.05.17: - Rebase to alpine 3.6.
- 03.05.17: - Fix log permissions.
- 18.03.17: - Note in readme about disabling dht in some circumstances.
- 24.02.17: - Patch a source file to quash rss https bug.
- 29.01.17: - Rebase to alpine 3.5.
- 20.11.16: - Add php7-mbstring package, bump mediainfo to 0.7.90.
- 14.10.16: - Add version layer information.
- 04.10.16: - Remove redundant sessions folder.
- 30.09.16: - Fix umask.
- 21.09.16: - Bump mediainfo, reorg dockerfile, add full wget package.
- 09.09.16: - Add layer badges to README.
- 28.08.16: - Add badges to README, bump mediainfo version to 0.7.87.
- 07.08.16: - Perms fix on nginx tmp folder, also exposed php.ini for editing by use in /config/php.
- 26.07.16: - Rebase to alpine.
- 08.03.16: - Initial Release.
linuxserver/sabnzbd¶
Sabnzbd makes Usenet as simple and streamlined as possible by automating everything we can. All you have to do is add an .nzb. SABnzbd takes over from there, where it will be automatically downloaded, verified, repaired, extracted and filed away with zero human interaction.
Supported Architectures¶
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/sabnzbd:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
| Tag | Available | Description |
|---|---|---|
| latest | ✅ | Stable SABnzbd releases |
| unstable | ✅ | Pre-releases from the develop branch |
| nightly | ✅ | Latest commits from the develop branch |
| ## Application Setup |
Initial setup is done via http://<docker host ip>:<mapped http port> ie, http://192.168.1.100:8080.
See the SABnzbd wiki for more information.
nzb-notify¶
nzb-notify is included with this image as a convenience script. To use it set the Scripts folder in the Folder settings to /app/nzbnotify and then configure it under Notifications. See nzb-notify for more information.
Download folders¶
In Sabnzbd gui settings, under Folders, make sure to set the Completed Download Folder as /downloads and the Temporary Download Folder as /incomplete-downloads
We have set /incomplete-downloads and /downloads as optional paths, this is because it is the easiest way to get started. While easy to use, it has some drawbacks. Mainly losing the ability to hardlink (TL;DR a way for a file to exist in multiple places on the same file system while only consuming one file worth of space), or atomic move (TL;DR instant file moves, rather than copy+delete) files while processing content.
Use the optional paths if you dont understand, or dont want hardlinks/atomic moves.
The folks over at servarr.com wrote a good write-up on how to get started with this.
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)¶
---
+ sabnzbd - LinuxServer.io linuxserver/sabnzbd¶
Sabnzbd makes Usenet as simple and streamlined as possible by automating everything we can. All you have to do is add an .nzb. SABnzbd takes over from there, where it will be automatically downloaded, verified, repaired, extracted and filed away with zero human interaction.
Supported Architectures¶
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/sabnzbd:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
Tag Available Description latest ✅ Stable SABnzbd releases unstable ✅ Pre-releases from the develop branch nightly ✅ Latest commits from the develop branch ## Application Setup
Initial setup is done via http://<docker host ip>:<mapped http port> ie, http://192.168.1.100:8080.
See the SABnzbd wiki for more information.
nzb-notify¶
nzb-notify is included with this image as a convenience script. To use it set the Scripts folder in the Folder settings to /app/nzbnotify and then configure it under Notifications. See nzb-notify for more information.
Download folders¶
In Sabnzbd gui settings, under Folders, make sure to set the Completed Download Folder as /downloads and the Temporary Download Folder as /incomplete-downloads
We have set /incomplete-downloads and /downloads as optional paths, this is because it is the easiest way to get started. While easy to use, it has some drawbacks. Mainly losing the ability to hardlink (TL;DR a way for a file to exist in multiple places on the same file system while only consuming one file worth of space), or atomic move (TL;DR instant file moves, rather than copy+delete) files while processing content.
Use the optional paths if you dont understand, or dont want hardlinks/atomic moves.
The folks over at servarr.com wrote a good write-up on how to get started with this.
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)¶
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 8080HTTP port for the WebUI.
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configLocal path for sabnzbd config files. /downloadsLocal path for finished downloads. /incomplete-downloadsLocal path for incomplete-downloads.
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:
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:
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 sabnzbd /bin/bash- To monitor the logs of the container in realtime:
docker logs -f sabnzbd- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' sabnzbd- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/sabnzbd:latest
Versions¶
- 16.08.23: - Install unrar from linuxserver repo.
- 10.08.23: - Bump unrar to 6.2.10.
- 16.05.23: - Rebase stable to Alpine 3.18, deprecate armhf.
- 15.03.23: - Switch from p7zip to 7zip, bump unrar to 6.2.6.
- 05.03.23: - Rebase master branch to Alpine 3.17.
- 03.10.22: - Rebase master branch to Alpine 3.16, migrate to s6v3.
- 12.08.22: - Bump unrar to 6.1.7.
- 31.07.22: - Add nightly tag.
- 10.03.22: - Add nzb-notify.
- 22.02.22: - Rebase master branch to Alpine, build unrar from source, deprecate Alpine branch.
- 25.01.22: - Rebase Unstable branch to Alpine.
- 13.01.22: - Add alpine branch
- 08.08.21: - Bump to focal, dont enforce binding to ipv4 port 8080
- 24.07.21: - Add python3-setuptools.
- 14.05.21: - Use linuxserver.io wheel index for pip packages.
- 12.02.21: - Clean up rust/cargo and pip cache.
- 17.08.20: - Run from source with python3 instead of ppa, remove python2 completely, symlink
python to python3. - 02.01.20: - Add python3 on top of python2 to image during transition.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 25.02.19: - Rebase to Bionic, add python deps for scripts.
- 26.01.19: - Add pipeline logic and multi arch.
- 13.12.17: - Fix continuation lines.
- 12.07.17: - Add inspect commands to README, move to jenkins build and push.
- 10.04.17: - Bump to 2.0 Release.
- 25.02.17: - Switch to nobetas repo for master/latest branch and add unstable branch.
- 08.02.17: - Add pythonioenconding=utf8 as env.
- 15.09.16: - Compile par2 multicore as per latest info sabnzbd git readme.
- 11.09.16: - Bump to release of 1.10.
- 09.09.16: - Rebase back to xenial, issues with alpine version of python and 1.10 branch of sab.
- 28.08.16: - Rebase to alpine, using git version of sab.
- 17.03.16: - Bump to install 1.0 final at startup.
- 14.03.16: - Refresh image to pick up latest RC.
- 23.01.15: - Refresh image.
- 14.12.15: - Refresh image to pick up latest beta.
- 21.08.15: - Initial Release.
\ No newline at end of file
+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 sabnzbd /bin/bash- To monitor the logs of the container in realtime:
docker logs -f sabnzbd- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' sabnzbd- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/sabnzbd:latest
Versions¶
- 16.08.23: - Install unrar from linuxserver repo.
- 10.08.23: - Bump unrar to 6.2.10.
- 16.05.23: - Rebase stable to Alpine 3.18, deprecate armhf.
- 15.03.23: - Switch from p7zip to 7zip, bump unrar to 6.2.6.
- 05.03.23: - Rebase master branch to Alpine 3.17.
- 03.10.22: - Rebase master branch to Alpine 3.16, migrate to s6v3.
- 12.08.22: - Bump unrar to 6.1.7.
- 31.07.22: - Add nightly tag.
- 10.03.22: - Add nzb-notify.
- 22.02.22: - Rebase master branch to Alpine, build unrar from source, deprecate Alpine branch.
- 25.01.22: - Rebase Unstable branch to Alpine.
- 13.01.22: - Add alpine branch
- 08.08.21: - Bump to focal, dont enforce binding to ipv4 port 8080
- 24.07.21: - Add python3-setuptools.
- 14.05.21: - Use linuxserver.io wheel index for pip packages.
- 12.02.21: - Clean up rust/cargo and pip cache.
- 17.08.20: - Run from source with python3 instead of ppa, remove python2 completely, symlink
pythontopython3. - 02.01.20: - Add python3 on top of python2 to image during transition.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 25.02.19: - Rebase to Bionic, add python deps for scripts.
- 26.01.19: - Add pipeline logic and multi arch.
- 13.12.17: - Fix continuation lines.
- 12.07.17: - Add inspect commands to README, move to jenkins build and push.
- 10.04.17: - Bump to 2.0 Release.
- 25.02.17: - Switch to nobetas repo for master/latest branch and add unstable branch.
- 08.02.17: - Add pythonioenconding=utf8 as env.
- 15.09.16: - Compile par2 multicore as per latest info sabnzbd git readme.
- 11.09.16: - Bump to release of 1.10.
- 09.09.16: - Rebase back to xenial, issues with alpine version of python and 1.10 branch of sab.
- 28.08.16: - Rebase to alpine, using git version of sab.
- 17.03.16: - Bump to install 1.0 final at startup.
- 14.03.16: - Refresh image to pick up latest RC.
- 23.01.15: - Refresh image.
- 14.12.15: - Refresh image to pick up latest beta.
- 21.08.15: - Initial Release.
DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. We recommend the official images: https://github.com/AnalogJ/scrutiny#docker
linuxserver/scrutiny¶
Scrutiny WebUI for smartd S.M.A.R.T monitoring. Scrutiny is a Hard Drive Health Dashboard & Monitoring solution, merging manufacturer provided S.M.A.R.T metrics with real-world failure rates from Backblaze.
Supported Architectures¶
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/scrutiny:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ✅ | arm32v7-<version tag> |
Application Setup¶
This container can be run as an 'all-in-one' deployment or as a hub / spoke deployment. Use the environment variables SCRUTINY_WEB and SCRUTINY_COLLECTOR to control the mode of the container. Setting both to true will deploy the container as both a collector and the web UI - this is the simplest and most straightforward deployment approach. To make use of the hub and spoke model, run this container in "collector" mode by specifying SCRUTINY_API_ENDPOINT. Set this to the host that is running the API. For this to work, you will need to expose the API port directly from the container (by default this is 8080).
You may need to manually enter the container to run scrutiny-collector-metrics run for your first job or wait until around midnight for it to kick off.
A fully commented example configuration yaml file can be found in the original project repository here. Place this file in the location mounted to /config.
A note on --cap-add for this container: * SYS_RAWIO is necessary to allow smartctl permission to query your device SMART data. * SYS_ADMIN is required for NVMe drives as per upstream issue #26.
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)¶
---
+ scrutiny - LinuxServer.io DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. We recommend the official images: https://github.com/AnalogJ/scrutiny#docker
linuxserver/scrutiny¶
Scrutiny WebUI for smartd S.M.A.R.T monitoring. Scrutiny is a Hard Drive Health Dashboard & Monitoring solution, merging manufacturer provided S.M.A.R.T metrics with real-world failure rates from Backblaze.
Supported Architectures¶
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/scrutiny:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ✅ arm32v7-<version tag>
Application Setup¶
This container can be run as an 'all-in-one' deployment or as a hub / spoke deployment. Use the environment variables SCRUTINY_WEB and SCRUTINY_COLLECTOR to control the mode of the container. Setting both to true will deploy the container as both a collector and the web UI - this is the simplest and most straightforward deployment approach. To make use of the hub and spoke model, run this container in "collector" mode by specifying SCRUTINY_API_ENDPOINT. Set this to the host that is running the API. For this to work, you will need to expose the API port directly from the container (by default this is 8080).
You may need to manually enter the container to run scrutiny-collector-metrics run for your first job or wait until around midnight for it to kick off.
A fully commented example configuration yaml file can be found in the original project repository here. Place this file in the location mounted to /config.
A note on --cap-add for this container: * SYS_RAWIO is necessary to allow smartctl permission to query your device SMART data. * SYS_ADMIN is required for NVMe drives as per upstream issue #26.
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)¶
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 8080Port for scrutiny's web interface and API.
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Europe/LondonSpecify a timezone to use EG Europe/London. SCRUTINY_API_ENDPOINT=http://localhost:8080# optional - API endpoint of the scrutiny UI. Do not change unless using as a remote collector SCRUTINY_WEB=true# optional - Run the web service. SCRUTINY_COLLECTOR=true# optional - Run the metrics collector.
Volume Mappings (-v)¶
Volume Function /configWhere config is stored. /run/udev:roProvides necessary metadata to Scrutiny.
Device Mappings (--device)¶
Parameter Function /dev/sdaThis is how Scrutiny accesses drives. Optionally supply /dev:/dev instead for all devices. /dev/sdbA second drive. /dev/nvme1n1An NVMe drive. NVMe requires --cap-add=SYS_ADMIN.
Miscellaneous Options¶
Parameter Function
Portainer notice¶
{% hint style="warning" %} This image utilises cap_add or sysctl to work properly. This is not implemented properly in some versions of Portainer, thus this image may not work if deployed through Portainer.
Environment variables from files (Docker secrets)¶
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
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:
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 scrutiny /bin/bash- To monitor the logs of the container in realtime:
docker logs -f scrutiny- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' scrutiny- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/scrutiny:latest
Versions¶
- 13.06.22: - Deprecate container.
- 19.01.22: - Rebase to Alpine 3.15.
- 22.11.20: - Added fix for
nsswitch.conf to resolve local hosts - 17.09.20: - Initial Release.
\ No newline at end of file
+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 scrutiny /bin/bash- To monitor the logs of the container in realtime:
docker logs -f scrutiny- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' scrutiny- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/scrutiny:latest
Versions¶
- 13.06.22: - Deprecate container.
- 19.01.22: - Rebase to Alpine 3.15.
- 22.11.20: - Added fix for
nsswitch.confto resolve local hosts - 17.09.20: - Initial Release.
DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. PLEASE MIGRATE TO THELOUNGE linuxserver/thelounge
linuxserver/shout-irc¶
Shout-irc is a web IRC client that you host on your own server.
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 linuxserver/shout-irc 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 | amd64-latest |
| arm64 | arm64v8-latest |
| armhf | arm32v7-latest |
Usage¶
Here are some example snippets to help you get started creating a container from this image.
docker¶
docker create \
+ shout-irc - LinuxServer.io DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. PLEASE MIGRATE TO THELOUNGE linuxserver/thelounge
linuxserver/shout-irc¶
Shout-irc is a web IRC client that you host on your own server.
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 linuxserver/shout-irc 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 amd64-latest arm64 arm64v8-latest armhf arm32v7-latest
Usage¶
Here are some example snippets to help you get started creating a container from this image.
docker¶
docker create \
--name=shout-irc \
-e PUID=1000 \
-e PGID=1000 \
@@ -24,4 +24,4 @@
restart: unless-stopped
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 9000Application WebUI
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Europe/LondonSpecify a timezone to use EG Europe/London.
Volume Mappings (-v)¶
Volume Function /configConfiguration files.
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:
Application Setup¶
- To log in to the application, browse to https://:9000. To setup user account(s) edit
/config/config.json Change the value public: true, to public: false, restart the container and enter the following from the command line of the host: docker exec -it thelounge thelounge add <user> Enter a password when prompted, refresh your browser. You should now be prompted for a password on the webinterface.
Support Info¶
- Shell access whilst the container is running:
docker exec -it shout-irc /bin/bash- To monitor the logs of the container in realtime:
docker logs -f shout-irc- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' shout-irc- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/shout-irc
Versions¶
- 11.06.19: - DEPRECATE IMAGE, USE THELOUNGE.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebasing to alpine 3.9.
- 28.01.19: - Add pipeline logic and multi arch.
- 25.08.18: - Rebase to alpine 3.8.
- 13.12.17: - Rebase to alpine 3.7.
- 27.05.17: - Rebase to alpine 3.6.
- 09.02.17: - Rebase to alpine 3.5.
- 14.10.16: - Add version layer information.
- 31.08.16: - Rebase to alpine linux, move to lsiocommunity
\ No newline at end of file
+Application Setup¶
- To log in to the application, browse to https://:9000. To setup user account(s) edit
/config/config.jsonChange the valuepublic: true,topublic: false,restart the container and enter the following from the command line of the host:docker exec -it thelounge thelounge add <user>Enter a password when prompted, refresh your browser. You should now be prompted for a password on the webinterface.
Support Info¶
- Shell access whilst the container is running:
docker exec -it shout-irc /bin/bash- To monitor the logs of the container in realtime:
docker logs -f shout-irc- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' shout-irc- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/shout-irc
Versions¶
- 11.06.19: - DEPRECATE IMAGE, USE THELOUNGE.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebasing to alpine 3.9.
- 28.01.19: - Add pipeline logic and multi arch.
- 25.08.18: - Rebase to alpine 3.8.
- 13.12.17: - Rebase to alpine 3.7.
- 27.05.17: - Rebase to alpine 3.6.
- 09.02.17: - Rebase to alpine 3.5.
- 14.10.16: - Add version layer information.
- 31.08.16: - Rebase to alpine linux, move to lsiocommunity
linuxserver/sickchill¶
Sickchill is an Automatic Video Library Manager for TV Shows. It watches for new episodes of your favorite shows, and when they are posted it does its magic.
Supported Architectures¶
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/sickchill:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
Web interface is at <your ip>:8081 , set paths for downloads, tv-shows to match docker mappings via the webui.
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)¶
---
+ sickchill - LinuxServer.io linuxserver/sickchill¶
Sickchill is an Automatic Video Library Manager for TV Shows. It watches for new episodes of your favorite shows, and when they are posted it does its magic.
Supported Architectures¶
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/sickchill:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
Web interface is at <your ip>:8081 , set paths for downloads, tv-shows to match docker mappings via the webui.
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)¶
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 8081will map the container's port 8081 to port 8081 on the host
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configthis will store config on the docker host /downloadsthis will store any downloaded data on the docker host /tvthis will allow sickchill to view what you already have
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:
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:
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 sickchill /bin/bash- To monitor the logs of the container in realtime:
docker logs -f sickchill- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' sickchill- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/sickchill:latest
Versions¶
- 10.08.23: - Bump unrar to 6.2.10.
- 12.07.23: - Rebase to alpine 3.18.
- 06.07.23: - Deprecate armhf. As announced here
- 17.02.22: - Rebase to alpine 3.17.
- 17.02.22: - Rebase to alpine 3.15.
- 20.11.21: - Modify binary usage from SickChill.py to SickChill.
- 14.05.21: - Add linuxserver wheel index.
- 12.02.21: - Rebasing to alpine 3.13. Add python certifi.
- 17.09.20: - Update dependencies.
- 06.09.20: - Switch to python3, install pip package.
- 22.04.20: - Switch to git clone and using git tags for versioning.
- 09.01.20: - Remove creating data volumes, fix build args for armhf and aarch64.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 17.04.19: - Adding Nodejs dependancy.
- 31.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 10.10.18: - Initial Release.
\ No newline at end of file
+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 sickchill /bin/bash- To monitor the logs of the container in realtime:
docker logs -f sickchill- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' sickchill- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/sickchill:latest
Versions¶
- 10.08.23: - Bump unrar to 6.2.10.
- 12.07.23: - Rebase to alpine 3.18.
- 06.07.23: - Deprecate armhf. As announced here
- 17.02.22: - Rebase to alpine 3.17.
- 17.02.22: - Rebase to alpine 3.15.
- 20.11.21: - Modify binary usage from SickChill.py to SickChill.
- 14.05.21: - Add linuxserver wheel index.
- 12.02.21: - Rebasing to alpine 3.13. Add python certifi.
- 17.09.20: - Update dependencies.
- 06.09.20: - Switch to python3, install pip package.
- 22.04.20: - Switch to git clone and using git tags for versioning.
- 09.01.20: - Remove creating data volumes, fix build args for armhf and aarch64.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 17.04.19: - Adding Nodejs dependancy.
- 31.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 10.10.18: - Initial Release.
linuxserver/sickgear¶
SickGear provides management of TV shows and/or Anime, it detects new episodes, links downloader apps, and more..
For more information on SickGear visit their website and check it out: https://github.com/SickGear/SickGear
Supported Architectures¶
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/sickgear:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ✅ | arm32v7-<version tag> |
Application Setup¶
Setting up the application¶
Access the webui at <your-ip>:8081, for more information check out SickGear.
Migration¶
Non linuxserver.io containers are known to have the following configuration differences and may need SickGear or docker changes to migrate an existing setup
-
The post processing directory which is volume mounted as
downloadswithin this container may beincomingin other versions. -
The permissions environmental variables which are defined as
PGIDandPUIDwithin this container may have beenAPP_UIDandAPP_UIDin other versions. -
The configuration file directory which is volume mounted as
configwithin this container may be set as the environmetal variableAPP_DATAin other versions. -
The cache directory which is set in
config.inimay be configured as a fixed pathcache_dir = /data/cache. Symptoms of this issue include port usage problems and a failure to start the web server log entries. Whilst the container is stopped alter this directive tocache_dir = cachewhich will allow SickGear to look for the folder relative to the volume mounted/configdirectory.
It is recommended that a clean install be completed, rather than a migration, however if migration is necessary:
-
start a new instance of this image
-
compare and align SickGear version numbers bewteen old and new. Ideally they should match but at a minumum the old vesion should be a lower version number to allow SickGear itself to try and migrate
-
stop both containers
-
notice the configuration difference and migrate copies of the old settings into the new app
-
start the new container and test
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)¶
---
+ sickgear - LinuxServer.io linuxserver/sickgear¶
SickGear provides management of TV shows and/or Anime, it detects new episodes, links downloader apps, and more..
For more information on SickGear visit their website and check it out: https://github.com/SickGear/SickGear
Supported Architectures¶
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/sickgear:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ✅ arm32v7-<version tag>
Application Setup¶
Setting up the application¶
Access the webui at <your-ip>:8081, for more information check out SickGear.
Migration¶
Non linuxserver.io containers are known to have the following configuration differences and may need SickGear or docker changes to migrate an existing setup
-
The post processing directory which is volume mounted as downloads within this container may be incoming in other versions.
-
The permissions environmental variables which are defined as PGID and PUID within this container may have been APP_UID and APP_UID in other versions.
-
The configuration file directory which is volume mounted as config within this container may be set as the environmetal variable APP_DATA in other versions.
-
The cache directory which is set in config.ini may be configured as a fixed path cache_dir = /data/cache. Symptoms of this issue include port usage problems and a failure to start the web server log entries. Whilst the container is stopped alter this directive to cache_dir = cache which will allow SickGear to look for the folder relative to the volume mounted /config directory.
It is recommended that a clean install be completed, rather than a migration, however if migration is necessary:
-
start a new instance of this image
-
compare and align SickGear version numbers bewteen old and new. Ideally they should match but at a minumum the old vesion should be a lower version number to allow SickGear itself to try and migrate
-
stop both containers
-
notice the configuration difference and migrate copies of the old settings into the new app
-
start the new container and test
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)¶
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 8081will map the container's port 8081 to port 8081 on the host
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configthis will store any uploaded data on the docker host /tvwhere you store your tv shows /downloadsyour downloads folder for post processing (must not be download in progress)
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:
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:
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 sickgear /bin/bash- To monitor the logs of the container in realtime:
docker logs -f sickgear- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' sickgear- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/sickgear:latest
Versions¶
- 10.08.23: - Bump unrar to 6.2.10.
- 27.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 05.03.23: - Rebase to Alpine 3.17.
- 18.11.22: - Update service file from legacy SickBeard.py to sickgear.py.
- 10.10.22: - Rebase to Alpine 3.16, migrate to s6v3.
- 19.09.22: - Rebase to alpine 3.15. Build unrar from source.
- 31.01.21: - Add unrar.
- 29.01.21: - Deprecate
UMASK_SET in favor of UMASK in baseimage, see above for more information. - 23.01.21: - Rebasing to alpine 3.13.
- 03.06.20: - Rebasing to alpine 3.12, switch to python3.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebasing to alpine 3.9.
- 07.11.18: - Pipeline prep
- 07.07.18: - Initial draft release
\ No newline at end of file
+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 sickgear /bin/bash- To monitor the logs of the container in realtime:
docker logs -f sickgear- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' sickgear- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/sickgear:latest
Versions¶
- 10.08.23: - Bump unrar to 6.2.10.
- 27.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 05.03.23: - Rebase to Alpine 3.17.
- 18.11.22: - Update service file from legacy SickBeard.py to sickgear.py.
- 10.10.22: - Rebase to Alpine 3.16, migrate to s6v3.
- 19.09.22: - Rebase to alpine 3.15. Build unrar from source.
- 31.01.21: - Add unrar.
- 29.01.21: - Deprecate
UMASK_SETin favor of UMASK in baseimage, see above for more information. - 23.01.21: - Rebasing to alpine 3.13.
- 03.06.20: - Rebasing to alpine 3.12, switch to python3.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebasing to alpine 3.9.
- 07.11.18: - Pipeline prep
- 07.07.18: - Initial draft release
DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. Please use linuxserver/sickchill instead
linuxserver/sickrage¶
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 linuxserver/sickrage 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 | amd64-latest |
| arm64 | arm64v8-latest |
| armhf | arm32v7-latest |
Usage¶
Here are some example snippets to help you get started creating a container from this image.
docker¶
docker create \
+ sickrage - LinuxServer.io DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. Please use linuxserver/sickchill instead
linuxserver/sickrage¶
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 linuxserver/sickrage 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 amd64-latest arm64 arm64v8-latest armhf arm32v7-latest
Usage¶
Here are some example snippets to help you get started creating a container from this image.
docker¶
docker create \
--name=sickrage \
-e PUID=1000 \
-e PGID=1000 \
@@ -28,4 +28,4 @@
restart: unless-stopped
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 8081Application WebUI
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Europe/LondonSpecify a timezone to use EG Europe/London.
Volume Mappings (-v)¶
Volume Function /configConfiguration files. /downloadsISOs. /tvTV library directory.
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:
Application Setup¶
Web interface is at <your ip>:8081 , set paths for downloads, tv-shows to match docker mappings via the webui.
Support Info¶
- Shell access whilst the container is running:
docker exec -it sickrage /bin/bash- To monitor the logs of the container in realtime:
docker logs -f sickrage- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' sickrage- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/sickrage
Versions¶
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebasing to alpine 3.9.
- 16.01.19: - Add pipeline logic and multi arch.
- 09.08.18: - Change repository to Sick-Rage
- 17.08.18: - Rebase to alpine 3.8.
- 20.03.18: - In lieu of a definite fix from SR, add nodejs package for use with torrentz and other sources.
- 12.12.17: - Rebase to alpine 3.7.
- 06.08.17: - Internal git pull instead of at runtime.
- 25.05.17: - Rebase to alpine 3.6.
- 07.02.17: - Rebase to alpine 3.5.
- 14.10.16: - Add version layer information.
- 30.09.16: - Fix umask.
- 09.09.16: - Add layer badges to README.
- 28.08.16: - Add badges to README.
- 08.08.16: - Rebase to alpine linux.
- 30.12.15: - Build later version of unrar from source, removed uneeded mako package.
- 20.11.15: - Updated to new repo, by SickRage Team.
- 15.10.15: - Initial Release.
\ No newline at end of file
+Application Setup¶
Web interface is at <your ip>:8081 , set paths for downloads, tv-shows to match docker mappings via the webui.
Support Info¶
- Shell access whilst the container is running:
docker exec -it sickrage /bin/bash- To monitor the logs of the container in realtime:
docker logs -f sickrage- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' sickrage- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' linuxserver/sickrage
Versions¶
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebasing to alpine 3.9.
- 16.01.19: - Add pipeline logic and multi arch.
- 09.08.18: - Change repository to Sick-Rage
- 17.08.18: - Rebase to alpine 3.8.
- 20.03.18: - In lieu of a definite fix from SR, add nodejs package for use with torrentz and other sources.
- 12.12.17: - Rebase to alpine 3.7.
- 06.08.17: - Internal git pull instead of at runtime.
- 25.05.17: - Rebase to alpine 3.6.
- 07.02.17: - Rebase to alpine 3.5.
- 14.10.16: - Add version layer information.
- 30.09.16: - Fix umask.
- 09.09.16: - Add layer badges to README.
- 28.08.16: - Add badges to README.
- 08.08.16: - Rebase to alpine linux.
- 30.12.15: - Build later version of unrar from source, removed uneeded mako package.
- 20.11.15: - Updated to new repo, by SickRage Team.
- 15.10.15: - Initial Release.
linuxserver/smokeping¶
Smokeping keeps track of your network latency. For a full example of what this application is capable of visit UCDavis.
Supported Architectures¶
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/smokeping:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
- Once running the URL will be
http://<host-ip>/smokeping/smokeping.cgi. For example a full URL might look likehttps://smokeping.yourdomain.com/smokeping/smokeping.cgi. - Basics are, edit the
Targetsfile to ping the hosts you're interested in to match the format found there. - Wait 10 minutes.
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)¶
---
+ smokeping - LinuxServer.io linuxserver/smokeping¶
Smokeping keeps track of your network latency. For a full example of what this application is capable of visit UCDavis.
Supported Architectures¶
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/smokeping:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
- Once running the URL will be
http://<host-ip>/smokeping/smokeping.cgi. For example a full URL might look like https://smokeping.yourdomain.com/smokeping/smokeping.cgi. - Basics are, edit the
Targets file to ping the hosts you're interested in to match the format found there. - Wait 10 minutes.
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)¶
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 80Allows HTTP access to the internal webserver.
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configConfigure the Targets file here /dataStorage location for db and application data (graphs etc)
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:
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:
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 smokeping /bin/bash- To monitor the logs of the container in realtime:
docker logs -f smokeping- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' smokeping- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/smokeping:latest
Versions¶
- 23.07.23: - Add Authen::TacacsPlus for Tacacs+ support.
- 16.05.23: - Add perl-authen-radius for Radius support.
- 16.05.23: - Rebase to Alpine 3.18. Deprecate armhf.
- 11.05.23: - Add perl-lwp-protocol-https for master/slave support over https.
- 22.01.23: - Revert to using Apache due to latency issues with nginx and fcgiwrap.
- 12.12.22: - Rebase to Alpine 3.17, migrate to s6v3, switch to nginx and fcgiwrap.
- 29.03.21: - Dockerfile: Install curl before we call it
- 23.01.21: - Rebasing to alpine 3.13.
- 01.06.20: - Rebasing to alpine 3.12.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebasing to alpine 3.9.
- 14.11.18: - Allow access without /smokeping in URL.
- 28.04.18: - Rebase to alpine 3.8.
- 09.04.18: - Add bc package.
- 08.04.18: - Add tccping script and tcptraceroute package (thanks rcarmo).
- 13.12.17: - Expose httpd_conf to /config.
- 13.12.17: - Rebase to alpine 3.7.
- 24.07.17: - Add :unraid tag for hosts without ipv6.
- 12.07.17: - Add inspect commands to README, move to jenkins build and push.
- 28.05.17: - Rebase to alpine 3.6.
- 07.05.17: - Expose smokeping.conf in /config/site-confs to allow user customisations
- 12.04.17: - Fix cropper.js path, thanks nibbledeez.
- 09.02.17: - Rebase to alpine 3.5.
- 17.10.16: - Add ttf-dejavu package as per LT forum.
- 10.09.16: - Add layer badges to README.
- 05.09.16: - Add curl package.
- 28.08.16: - Add badges to README.
- 25.07.16: - Rebase to alpine linux.
- 23.07.16: - Fix apt script confusion.
- 29.06.15: - This is the first release, it is mostly stable, but may contain minor defects. (thus a beta tag)
\ No newline at end of file
+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 smokeping /bin/bash- To monitor the logs of the container in realtime:
docker logs -f smokeping- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' smokeping- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/smokeping:latest
Versions¶
- 23.07.23: - Add Authen::TacacsPlus for Tacacs+ support.
- 16.05.23: - Add perl-authen-radius for Radius support.
- 16.05.23: - Rebase to Alpine 3.18. Deprecate armhf.
- 11.05.23: - Add perl-lwp-protocol-https for master/slave support over https.
- 22.01.23: - Revert to using Apache due to latency issues with nginx and fcgiwrap.
- 12.12.22: - Rebase to Alpine 3.17, migrate to s6v3, switch to nginx and fcgiwrap.
- 29.03.21: - Dockerfile: Install curl before we call it
- 23.01.21: - Rebasing to alpine 3.13.
- 01.06.20: - Rebasing to alpine 3.12.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebasing to alpine 3.9.
- 14.11.18: - Allow access without /smokeping in URL.
- 28.04.18: - Rebase to alpine 3.8.
- 09.04.18: - Add bc package.
- 08.04.18: - Add tccping script and tcptraceroute package (thanks rcarmo).
- 13.12.17: - Expose httpd_conf to /config.
- 13.12.17: - Rebase to alpine 3.7.
- 24.07.17: - Add :unraid tag for hosts without ipv6.
- 12.07.17: - Add inspect commands to README, move to jenkins build and push.
- 28.05.17: - Rebase to alpine 3.6.
- 07.05.17: - Expose smokeping.conf in /config/site-confs to allow user customisations
- 12.04.17: - Fix cropper.js path, thanks nibbledeez.
- 09.02.17: - Rebase to alpine 3.5.
- 17.10.16: - Add ttf-dejavu package as per LT forum.
- 10.09.16: - Add layer badges to README.
- 05.09.16: - Add curl package.
- 28.08.16: - Add badges to README.
- 25.07.16: - Rebase to alpine linux.
- 23.07.16: - Fix apt script confusion.
- 29.06.15: - This is the first release, it is mostly stable, but may contain minor defects. (thus a beta tag)
linuxserver/snapdrop¶
Snapdrop A local file sharing in your browser. Inspired by Apple's Airdrop.
Supported Architectures¶
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/snapdrop:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
Webui is accessible at http://SERVERIP:PORT
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)¶
---
+ snapdrop - LinuxServer.io linuxserver/snapdrop¶
Snapdrop A local file sharing in your browser. Inspired by Apple's Airdrop.
Supported Architectures¶
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/snapdrop:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
Webui is accessible at http://SERVERIP:PORT
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)¶
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 80http gui 443https gui
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configPersistent configs and logs.
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:
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:
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 snapdrop /bin/bash- To monitor the logs of the container in realtime:
docker logs -f snapdrop- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' snapdrop- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/snapdrop:latest
Versions¶
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 13.04.23: - Move ssl.conf include to default.conf.
- 20.01.23: - Rebase to alpine 3.17 with php8.1.
- 20.08.22: - Rebasing to alpine 3.15 with php8. Restructure nginx configs (see changes announcement).
- 09.08.21: - Rebase to Alpine 3.14. Add real_ip block to nginx default site config.
- 15.09.20: - Initial Release.
\ No newline at end of file
+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 snapdrop /bin/bash- To monitor the logs of the container in realtime:
docker logs -f snapdrop- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' snapdrop- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/snapdrop:latest
Versions¶
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 13.04.23: - Move ssl.conf include to default.conf.
- 20.01.23: - Rebase to alpine 3.17 with php8.1.
- 20.08.22: - Rebasing to alpine 3.15 with php8. Restructure nginx configs (see changes announcement).
- 09.08.21: - Rebase to Alpine 3.14. Add real_ip block to nginx default site config.
- 15.09.20: - Initial Release.
linuxserver/snipe-it¶
Snipe-it makes asset management easy. It was built by people solving real-world IT and asset management problems, and a solid UX has always been a top priority. Straightforward design and bulk actions mean getting things done faster.
Supported Architectures¶
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/snipe-it:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
Access the webui at <your-ip>:8080, for more information check out Snipe-it. This container requires a MySQL or MariaDB server to connect to, we reccomend ours
This container also generates an SSL certificate and stores it in
/config/keys/cert.crt
+ snipe-it - LinuxServer.io linuxserver/snipe-it¶
Snipe-it makes asset management easy. It was built by people solving real-world IT and asset management problems, and a solid UX has always been a top priority. Straightforward design and bulk actions mean getting things done faster.
Supported Architectures¶
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/snipe-it:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
Access the webui at <your-ip>:8080, for more information check out Snipe-it. This container requires a MySQL or MariaDB server to connect to, we reccomend ours
This container also generates an SSL certificate and stores it in
To use your own certificate swap these files with yours. To use SSL forward your port to 443 inside the container IE: The application accepts a series of environment variables to further customize itself on boot:
Parameter Function -e APP_ENV=Default is production but can use testing or develop -e APP_DEBUG=Set to true to see debugging output in the web UI -e APP_LOCALE=Default is en set to the language preferred full list here -e MAIL_PORT_587_TCP_ADDR=SMTP mailserver ip or hostname -e MAIL_PORT_587_TCP_PORT=SMTP mailserver port -e MAIL_ENV_FROM_ADDR=The email address mail should be replied to and listed when sent -e MAIL_ENV_FROM_NAME=The name listed on email sent from the default account on the system -e MAIL_ENV_ENCRYPTION=Mail encryption to use IE tls -e MAIL_ENV_USERNAME=SMTP server login username -e MAIL_ENV_PASSWORD=SMTP server login password
PHP customization¶
This image uses our NGINX base image all configuration files for PHP and NGINX are located in /config/php. To overide any defaults please modify /config/php/php-local.ini IE for upload size:
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 80Snipe-IT Web UI
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. APP_URL=http://localhost:8080Hostname or IP and port if applicable, be sure to define https/http MYSQL_PORT_3306_TCP_ADDR=Mysql hostname or IP to use MYSQL_PORT_3306_TCP_PORT=Mysql port to use MYSQL_DATABASE=Mysql database to use MYSQL_USER=Mysql user to use MYSQL_PASSWORD=Mysql password to use
Volume Mappings (-v)¶
Volume Function /configContains your config files and data storage for Snipe-IT
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:
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:
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 snipe-it /bin/bash- To monitor the logs of the container in realtime:
docker logs -f snipe-it- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' snipe-it- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/snipe-it:latest
Versions¶
- 03.07.23: - Deprecate armhf. As announced here
- 13.04.23: - Move ssl.conf include to default.conf.
- 13.04.23: - Add php81-pecl-redis for redis support.
- 28.12.22: - Rebase to Alpine 3.17, migrate to s6v3.
- 20.08.22: - Rebasing to alpine 3.15 with php8. Restructure nginx configs (see changes announcement).
- 14.05.22: - Add php7-sodium for v6.
- 12.04.22: - Don't build development elements.
- 02.03.22: - Rework init logic, do not show default compose.
- 29.06.21: - Rebasing to alpine 3.14.
- 30.04.21: - Rebasing to alpine 3.13, add artisan migrate on spinup.
- 01.06.20: - Rebasing to alpine 3.12.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 10.04.19: - Add php deps for V4.7.0, ensure framework directories are available at build time.
- 10.04.19: - Fix permissions for new bootstrap cache directory.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebasing to alpine 3.9.
- 31.10.18: - Rebasing to alpine 3.8
- 05.08.18: - Migration to live build server.
- 13.06.18: - Initial Release.
\ No newline at end of file
+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 snipe-it /bin/bash- To monitor the logs of the container in realtime:
docker logs -f snipe-it- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' snipe-it- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/snipe-it:latest
Versions¶
- 03.07.23: - Deprecate armhf. As announced here
- 13.04.23: - Move ssl.conf include to default.conf.
- 13.04.23: - Add php81-pecl-redis for redis support.
- 28.12.22: - Rebase to Alpine 3.17, migrate to s6v3.
- 20.08.22: - Rebasing to alpine 3.15 with php8. Restructure nginx configs (see changes announcement).
- 14.05.22: - Add php7-sodium for v6.
- 12.04.22: - Don't build development elements.
- 02.03.22: - Rework init logic, do not show default compose.
- 29.06.21: - Rebasing to alpine 3.14.
- 30.04.21: - Rebasing to alpine 3.13, add artisan migrate on spinup.
- 01.06.20: - Rebasing to alpine 3.12.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 10.04.19: - Add php deps for V4.7.0, ensure framework directories are available at build time.
- 10.04.19: - Fix permissions for new bootstrap cache directory.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebasing to alpine 3.9.
- 31.10.18: - Rebasing to alpine 3.8
- 05.08.18: - Migration to live build server.
- 13.06.18: - Initial Release.
linuxserver/sonarr¶
Sonarr (formerly NZBdrone) is a PVR for usenet and bittorrent users. It can monitor multiple RSS feeds for new episodes of your favorite shows and will grab, sort and rename them. It can also be configured to automatically upgrade the quality of files already downloaded when a better quality format becomes available.
Supported Architectures¶
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/sonarr:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
| Tag | Available | Description |
|---|---|---|
| latest | ✅ | Stable releases from Sonarr (currently v3) |
| develop | ✅ | Development releases from Sonarr (currently v4) |
| ## Application Setup |
Access the webui at <your-ip>:8989, for more information check out Sonarr.
Media folders¶
We have set /tv and /downloads as optional paths, this is because it is the easiest way to get started. While easy to use, it has some drawbacks. Mainly losing the ability to hardlink (TL;DR a way for a file to exist in multiple places on the same file system while only consuming one file worth of space), or atomic move (TL;DR instant file moves, rather than copy+delete) files while processing content.
Use the optional paths if you dont understand, or dont want hardlinks/atomic moves.
The folks over at servarr.com wrote a good write-up on how to get started with this.
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)¶
---
+ sonarr - LinuxServer.io linuxserver/sonarr¶
Sonarr (formerly NZBdrone) is a PVR for usenet and bittorrent users. It can monitor multiple RSS feeds for new episodes of your favorite shows and will grab, sort and rename them. It can also be configured to automatically upgrade the quality of files already downloaded when a better quality format becomes available.
Supported Architectures¶
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/sonarr:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
Tag Available Description latest ✅ Stable releases from Sonarr (currently v3) develop ✅ Development releases from Sonarr (currently v4) ## Application Setup
Access the webui at <your-ip>:8989, for more information check out Sonarr.
Media folders¶
We have set /tv and /downloads as optional paths, this is because it is the easiest way to get started. While easy to use, it has some drawbacks. Mainly losing the ability to hardlink (TL;DR a way for a file to exist in multiple places on the same file system while only consuming one file worth of space), or atomic move (TL;DR instant file moves, rather than copy+delete) files while processing content.
Use the optional paths if you dont understand, or dont want hardlinks/atomic moves.
The folks over at servarr.com wrote a good write-up on how to get started with this.
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)¶
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 8989The port for the Sonarr webinterface
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configDatabase and sonarr configs /tvLocation of TV library on disk (See note in Application setup) /downloadsLocation of download managers output directory (See note in Application setup)
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:
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:
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 sonarr /bin/bash- To monitor the logs of the container in realtime:
docker logs -f sonarr- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' sonarr- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/sonarr:latest
Versions¶
- 15.02.23: - Rebase master branch to Jammy.
- 19.12.22: - Rebase develop branch Alpine 3.17.
- 24.11.22: - Bump develop branch to v4, rebase to Alpine 3.16.
- 03.08.22: - Deprecate armhf.
- 02.08.22: - Add armhf deprecation warning.
- 28.04.22: - Rebase master branch to mono 6.12 base (focal).
- 20.02.22: - Rebase develop branch to Alpine, deprecate develop-alpine branch.
- 28.12.21: - Add develop-alpine branch.
- 11.05.21: - Make the paths clearer to the user.
- 10.03.21: - Upgrade to Sonarr v3. Existing users are highly recommended to make a backup prior to update.
- 18.01.21: - Deprecate
UMASK_SET in favor of UMASK in baseimage, see above for more information. - 05.04.20: - Move app to /app.
- 01.08.19: - Rebase to Linuxserver LTS mono version.
- 13.06.19: - Add env variable for setting umask.
- 10.05.19: - Rebase to Bionic.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 01.02.19: - Multi arch images and pipeline build logic
- 15.12.17: - Fix continuation lines.
- 12.07.17: - Add inspect commands to README, move to jenkins build and push.
- 17.04.17: - Switch to using inhouse mono baseimage, adds python also.
- 14.04.17: - Change to mount /etc/localtime in README, thanks cbgj.
- 13.04.17: - Switch to official mono repository.
- 30.09.16: - Fix umask
- 23.09.16: - Add cd to /opt fixes redirects with althub (issue #25), make XDG config environment variable
- 15.09.16: - Add libcurl3 package.
- 09.09.16: - Add layer badges to README.
- 27.08.16: - Add badges to README.
- 20.07.16: - Rebase to xenial.
- 31.08.15: - Cleanup, changed sources to fetch binarys from. also a new baseimage.
\ No newline at end of file
+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 sonarr /bin/bash- To monitor the logs of the container in realtime:
docker logs -f sonarr- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' sonarr- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/sonarr:latest
Versions¶
- 15.02.23: - Rebase master branch to Jammy.
- 19.12.22: - Rebase develop branch Alpine 3.17.
- 24.11.22: - Bump develop branch to v4, rebase to Alpine 3.16.
- 03.08.22: - Deprecate armhf.
- 02.08.22: - Add armhf deprecation warning.
- 28.04.22: - Rebase master branch to mono 6.12 base (focal).
- 20.02.22: - Rebase develop branch to Alpine, deprecate develop-alpine branch.
- 28.12.21: - Add develop-alpine branch.
- 11.05.21: - Make the paths clearer to the user.
- 10.03.21: - Upgrade to Sonarr v3. Existing users are highly recommended to make a backup prior to update.
- 18.01.21: - Deprecate
UMASK_SETin favor of UMASK in baseimage, see above for more information. - 05.04.20: - Move app to /app.
- 01.08.19: - Rebase to Linuxserver LTS mono version.
- 13.06.19: - Add env variable for setting umask.
- 10.05.19: - Rebase to Bionic.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 01.02.19: - Multi arch images and pipeline build logic
- 15.12.17: - Fix continuation lines.
- 12.07.17: - Add inspect commands to README, move to jenkins build and push.
- 17.04.17: - Switch to using inhouse mono baseimage, adds python also.
- 14.04.17: - Change to mount /etc/localtime in README, thanks cbgj.
- 13.04.17: - Switch to official mono repository.
- 30.09.16: - Fix umask
- 23.09.16: - Add cd to /opt fixes redirects with althub (issue #25), make XDG config environment variable
- 15.09.16: - Add libcurl3 package.
- 09.09.16: - Add layer badges to README.
- 27.08.16: - Add badges to README.
- 20.07.16: - Rebase to xenial.
- 31.08.15: - Cleanup, changed sources to fetch binarys from. also a new baseimage.
linuxserver/sqlitebrowser¶
DB Browser for SQLite is a high quality, visual, open source tool to create, design, and edit database files compatible with SQLite.
Supported Architectures¶
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/sqlitebrowser:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
The application can be accessed at:
- http://yourhost:3000/
- https://yourhost:3001/
Options in all KasmVNC based GUI containers¶
This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.
Optional environment variables¶
| Variable | Description |
|---|---|
| CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default 3000. |
| CUSTOM_HTTPS_PORT | Internal port the container listens on for https if it needs to be swapped from the default 3001. |
| CUSTOM_USER | HTTP Basic auth username, abc is default. |
| PASSWORD | HTTP Basic auth password, abc is default. If unset there will be no auth |
| SUBFOLDER | Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/ |
| TITLE | The page title displayed on the web browser, default "KasmVNC Client". |
| FM_HOME | This is the home directory (landing) for the file manager, default "/config". |
| START_DOCKER | If set to false a container with privilege will not automatically start the DinD Docker setup. |
| DRINODE | If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE /dev/dri/renderD128 |
Optional run configurations¶
| Variable | Description |
|---|---|
--privileged | Will start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE -v /home/user/docker-data:/var/lib/docker. |
-v /var/run/docker.sock:/var/run/docker.sock | Mount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. |
--device /dev/dri:/dev/dri | Mount a GPU into the container, this can be used in conjunction with the DRINODE environment variable to leverage a host video card for GPU accelerated appplications. Only Open Source drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau) |
Lossless mode¶
This container is capable of delivering a true lossless image at a high framerate to your web browser by changing the Stream Quality preset to "Lossless", more information here. In order to use this mode from a non localhost endpoint the HTTPS port on 3001 needs to be used. If using a reverse proxy to port 3000 specific headers will need to be set as outlined here.
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)¶
---
+ sqlitebrowser - LinuxServer.io linuxserver/sqlitebrowser¶
DB Browser for SQLite is a high quality, visual, open source tool to create, design, and edit database files compatible with SQLite.
Supported Architectures¶
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/sqlitebrowser:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
The application can be accessed at:
- http://yourhost:3000/
- https://yourhost:3001/
Options in all KasmVNC based GUI containers¶
This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.
Optional environment variables¶
Variable Description CUSTOM_PORT Internal port the container listens on for http if it needs to be swapped from the default 3000. CUSTOM_HTTPS_PORT Internal port the container listens on for https if it needs to be swapped from the default 3001. CUSTOM_USER HTTP Basic auth username, abc is default. PASSWORD HTTP Basic auth password, abc is default. If unset there will be no auth SUBFOLDER Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/ TITLE The page title displayed on the web browser, default "KasmVNC Client". FM_HOME This is the home directory (landing) for the file manager, default "/config". START_DOCKER If set to false a container with privilege will not automatically start the DinD Docker setup. DRINODE If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE /dev/dri/renderD128
Optional run configurations¶
Variable Description --privilegedWill start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE -v /home/user/docker-data:/var/lib/docker. -v /var/run/docker.sock:/var/run/docker.sockMount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. --device /dev/dri:/dev/driMount a GPU into the container, this can be used in conjunction with the DRINODE environment variable to leverage a host video card for GPU accelerated appplications. Only Open Source drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau)
Lossless mode¶
This container is capable of delivering a true lossless image at a high framerate to your web browser by changing the Stream Quality preset to "Lossless", more information here. In order to use this mode from a non localhost endpoint the HTTPS port on 3001 needs to be used. If using a reverse proxy to port 3000 specific headers will need to be set as outlined here.
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)¶
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 3000Sqlitebrowser desktop gui. 3001Sqlitebrowser desktop gui HTTPS.
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configUsers home directory in the container, stores program settings and potentially dump files.
Miscellaneous Options¶
Parameter Function --security-opt seccomp=unconfinedFor Docker Engine only, many modern gui apps need this to function on older hosts as syscalls are unknown to Docker.
Environment variables from files (Docker secrets)¶
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
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:
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 sqlitebrowser /bin/bash- To monitor the logs of the container in realtime:
docker logs -f sqlitebrowser- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' sqlitebrowser- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/sqlitebrowser:latest
Versions¶
- 13.05.23: - Rebase to Alpine 3.18.
- 18.03.23: - Rebase to KasmVNC base image.
- 23.10.22: - Rebase to Alpine 3.16, migrate to s6v3.
- 16.02.22: - Rebase to Alpine.
- 20.01.21: - Remove Wireshark reference.
- 29.07.20: - Initial release.
\ No newline at end of file
+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 sqlitebrowser /bin/bash- To monitor the logs of the container in realtime:
docker logs -f sqlitebrowser- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' sqlitebrowser- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/sqlitebrowser:latest
Versions¶
- 13.05.23: - Rebase to Alpine 3.18.
- 18.03.23: - Rebase to KasmVNC base image.
- 23.10.22: - Rebase to Alpine 3.16, migrate to s6v3.
- 16.02.22: - Rebase to Alpine.
- 20.01.21: - Remove Wireshark reference.
- 29.07.20: - Initial release.
linuxserver/steamos¶
SteamOS is an Arch based Linux distribution made by Valve Software. This container is a vanilla Arch install with Steam repositories added for software support. This container will only work with modern AMD/Intel GPUs on a real Linux Host
Supported Architectures¶
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/steamos:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ❌ | |
| armhf | ❌ |
Application Setup¶
This container is currently in a Beta state and is developing quickly, things will change constantly and it may crash or not function perfectly especially when mixing Steam remote play frame capture with the web based KasmVNC frame capture
SteamOS is designed for specific AMD based hardware, this container will only work properly on a host with a modern AMD GPU or Intel ARC/iGPU
The following limitations currently exist: * You must run the desktop mode initially to login to Steam, then you can switch to STARTUP=BIGPICTURE * Sunshine is available in both desktop mode (KDE) and BIGPICTURE, but gamepads using Sunshine does not currently work. * In Desktop mode most proton games will kill off kwin_x11 and in turn disable keyboard and gamepad input. For remote play in Desktop mode it is mostly Valve or Linux native titles that function properly. * If games are not launching and are Windows based ensure you have forced a compatibility layer in it's settings to use Proton Experimental or Proton 8. * BIGPICTURE STARTUP mode connecting via Sunshine will have much better game compatibility and generally be less buggy. Titles are running how the Steam Deck expects them to inside a gamescope renderer, outside of the lack of gamepads this works identically to a Deck. * Sunshine auto discovery is not functional, you will need to manually enter the IP in your client. * Remote play does not function well in BIGPICTURE mode, this mode is optimized for a single resolution passed on boot using Sunshine.
To improve compatibility we ingest drivers from vanilla Arch repos, but NVIDIA will never work. This is a limitation of the KasmVNC virtual framebuffer that we use as it only has logic for the DRI3 framework which is not available for NVIDIA. We recommend using a modern RDNA AMD card or Intel ARC card, but lower end GPUs might work for some games we do bundle all the drivers that are possible to install. Compatibility should be on par with the Steam Deck, if it is certified for the Deck it will run in our testing and the game should be fully playable.
The application can be accessed at:
- http://yourhost:3000/
- https://yourhost:3001/
Options in all KasmVNC based GUI containers¶
This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.
Optional environment variables¶
| Variable | Description |
|---|---|
| CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default 3000. |
| CUSTOM_HTTPS_PORT | Internal port the container listens on for https if it needs to be swapped from the default 3001. |
| CUSTOM_USER | HTTP Basic auth username, abc is default. |
| PASSWORD | HTTP Basic auth password, abc is default. If unset there will be no auth |
| SUBFOLDER | Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/ |
| TITLE | The page title displayed on the web browser, default "KasmVNC Client". |
| FM_HOME | This is the home directory (landing) for the file manager, default "/config". |
| DRINODE | If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE /dev/dri/renderD128 |
Networking¶
Windows users will need to disable their firewall for remote play to function in the default setup
The Steam Link application will only function in Host or Macvlan networking modes
Steam network discovery in it's current state is pretty inflexible, to function locally it uses broadcast packets that cannot traverse subnets and this becomes a problem when using a Docker subnet. In the default configuration we recommend forwarding the ports and passing the underlying host's IP using the HOST_IP environment variable. When the container spins up it will set this IP as it's default route allowing remote play to function over a local network given the client does not have a firewall in the way blocking the traffic. If you never plan to use remote play or only plan on using it fully remote off your LAN through a Valve relay then you can essentially rip out all the logic for Steam port forwarding and passing the host ip to the container.
Optimally Macvlan can be used to give this container a dedicated IP on your network and run closer to how a bridged VM would. This is the most compatible methodology and will avoid any potentially port conflicts.
Host Networking can also be used, but might run into a port conflict with what the container is trying to init and the underlying host.
Gameplay¶
Keep in mind this container thinks it is a Steam Deck, games will be optimized for it's controller layout and video settings. To get a desktop Steam experience for remote play or testing there is a desktop shortcut provided Steam Desktop Mode. Most games will tie themselves to the current desktop resolution as set when you connect to the web interface, a method for setting the resolution via the web interface is being worked on. Authentication (not two factor) is not currently saved when closing and re-opening Steam for any reason when in Deck mode this is also being worked on. This means anytime you restart the container you will need to access the web interface and log back in. It is possible to play games over KasmVNC, but it as a protocol is not currently optimized for gaming. You will experience more frame skipping and latency as compared to Steam remote play.
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)¶
---
+ steamos - LinuxServer.io linuxserver/steamos¶
SteamOS is an Arch based Linux distribution made by Valve Software. This container is a vanilla Arch install with Steam repositories added for software support. This container will only work with modern AMD/Intel GPUs on a real Linux Host
Supported Architectures¶
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/steamos:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ❌ armhf ❌
Application Setup¶
This container is currently in a Beta state and is developing quickly, things will change constantly and it may crash or not function perfectly especially when mixing Steam remote play frame capture with the web based KasmVNC frame capture
SteamOS is designed for specific AMD based hardware, this container will only work properly on a host with a modern AMD GPU or Intel ARC/iGPU
The following limitations currently exist: * You must run the desktop mode initially to login to Steam, then you can switch to STARTUP=BIGPICTURE * Sunshine is available in both desktop mode (KDE) and BIGPICTURE, but gamepads using Sunshine does not currently work. * In Desktop mode most proton games will kill off kwin_x11 and in turn disable keyboard and gamepad input. For remote play in Desktop mode it is mostly Valve or Linux native titles that function properly. * If games are not launching and are Windows based ensure you have forced a compatibility layer in it's settings to use Proton Experimental or Proton 8. * BIGPICTURE STARTUP mode connecting via Sunshine will have much better game compatibility and generally be less buggy. Titles are running how the Steam Deck expects them to inside a gamescope renderer, outside of the lack of gamepads this works identically to a Deck. * Sunshine auto discovery is not functional, you will need to manually enter the IP in your client. * Remote play does not function well in BIGPICTURE mode, this mode is optimized for a single resolution passed on boot using Sunshine.
To improve compatibility we ingest drivers from vanilla Arch repos, but NVIDIA will never work. This is a limitation of the KasmVNC virtual framebuffer that we use as it only has logic for the DRI3 framework which is not available for NVIDIA. We recommend using a modern RDNA AMD card or Intel ARC card, but lower end GPUs might work for some games we do bundle all the drivers that are possible to install. Compatibility should be on par with the Steam Deck, if it is certified for the Deck it will run in our testing and the game should be fully playable.
The application can be accessed at:
- http://yourhost:3000/
- https://yourhost:3001/
Options in all KasmVNC based GUI containers¶
This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.
Optional environment variables¶
Variable Description CUSTOM_PORT Internal port the container listens on for http if it needs to be swapped from the default 3000. CUSTOM_HTTPS_PORT Internal port the container listens on for https if it needs to be swapped from the default 3001. CUSTOM_USER HTTP Basic auth username, abc is default. PASSWORD HTTP Basic auth password, abc is default. If unset there will be no auth SUBFOLDER Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/ TITLE The page title displayed on the web browser, default "KasmVNC Client". FM_HOME This is the home directory (landing) for the file manager, default "/config". DRINODE If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE /dev/dri/renderD128
Networking¶
Windows users will need to disable their firewall for remote play to function in the default setup
The Steam Link application will only function in Host or Macvlan networking modes
Steam network discovery in it's current state is pretty inflexible, to function locally it uses broadcast packets that cannot traverse subnets and this becomes a problem when using a Docker subnet. In the default configuration we recommend forwarding the ports and passing the underlying host's IP using the HOST_IP environment variable. When the container spins up it will set this IP as it's default route allowing remote play to function over a local network given the client does not have a firewall in the way blocking the traffic. If you never plan to use remote play or only plan on using it fully remote off your LAN through a Valve relay then you can essentially rip out all the logic for Steam port forwarding and passing the host ip to the container.
Optimally Macvlan can be used to give this container a dedicated IP on your network and run closer to how a bridged VM would. This is the most compatible methodology and will avoid any potentially port conflicts.
Host Networking can also be used, but might run into a port conflict with what the container is trying to init and the underlying host.
Gameplay¶
Keep in mind this container thinks it is a Steam Deck, games will be optimized for it's controller layout and video settings. To get a desktop Steam experience for remote play or testing there is a desktop shortcut provided Steam Desktop Mode. Most games will tie themselves to the current desktop resolution as set when you connect to the web interface, a method for setting the resolution via the web interface is being worked on. Authentication (not two factor) is not currently saved when closing and re-opening Steam for any reason when in Deck mode this is also being worked on. This means anytime you restart the container you will need to access the web interface and log back in. It is possible to play games over KasmVNC, but it as a protocol is not currently optimized for gaming. You will experience more frame skipping and latency as compared to Steam remote play.
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)¶
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 3000SteamOS desktop gui. 3001HTTPS SteamOS desktop gui. 27031-27036/udpSteam Remote Play Ports (UDP). 27031-27036Steam Remote Play Ports (TCP). 47984-47990Sunshine Ports (TCP). 48010-48010Sunshine Ports (TCP). 47998-48000/udpSunshine Ports (UDP).
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. DRINODE=/dev/dri/renderD128Specify the render device (GPU) for the contianer to use. HOST_IP=192.168.100.10Specify the IP of the host, needed for LAN Remote Play. STARTUP=KDEKDE to boot into desktop mode, BIGPICTURE to boot into gamescope. RESOLUTION=1920x1080When booting into BIGPICTURE mode the screen resolution will be bound to this value.
Volume Mappings (-v)¶
Volume Function /configUsers home directory in the container, stores all files and games. /dev/inputOptional for gamepad support. *Only working for Steam Remote Play /run/udev/dataOptional for gamepad support. *Only working for Steam Remote Play
Device Mappings (--device)¶
Parameter Function /dev/driVideo card passthrough to Steam.
Miscellaneous Options¶
Parameter Function --hostname=Specify the hostname of the host, this is useful for keeping a persistent hostname between upgrades and identifying the server in the remote play Steam Client. --shm-size=This is needed for the steam browser to function properly. --security-opt seccomp=unconfinedThis is needed to allow kernel syscalls made by Steam. --security-opt apparmor=unconfinedFor Debian/Ubuntu hosts Steam needs elevated perms that AppArmor blocks.
Portainer notice¶
{% hint style="warning" %} This image utilises cap_add or sysctl to work properly. This is not implemented properly in some versions of Portainer, thus this image may not work if deployed through Portainer.
Environment variables from files (Docker secrets)¶
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
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:
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 steamos /bin/bash- To monitor the logs of the container in realtime:
docker logs -f steamos- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' steamos- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/steamos:latest
Versions¶
- 25.08.23: - Add deps needed for some audio and software compatibility.
- 04.07.23: - Initial release.
\ No newline at end of file
+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 steamos /bin/bash- To monitor the logs of the container in realtime:
docker logs -f steamos- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' steamos- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/steamos:latest
Versions¶
- 25.08.23: - Add deps needed for some audio and software compatibility.
- 04.07.23: - Initial release.
linuxserver/swag¶
SWAG - Secure Web Application Gateway (formerly known as letsencrypt, no relation to Let's Encrypt™) sets up an Nginx webserver and reverse proxy with php support and a built-in certbot client that automates free SSL server certificate generation and renewal processes (Let's Encrypt and ZeroSSL). It also contains fail2ban for intrusion prevention.
Supported Architectures¶
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/swag:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
Validation and initial setup¶
- Before running this container, make sure that the url and subdomains are properly forwarded to this container's host, and that port 443 (and/or 80) is not being used by another service on the host (NAS gui, another webserver, etc.).
- If you need a dynamic dns provider, you can use the free provider duckdns.org where the
URLwill beyoursubdomain.duckdns.organd theSUBDOMAINScan bewww,ftp,cloudwith http validation, orwildcardwith dns validation. You can use our duckdns image to update your IP on duckdns.org. - For
httpvalidation, port 80 on the internet side of the router should be forwarded to this container's port 80 - For
dnsvalidation, make sure to enter your credentials into the corresponding ini (or json for some plugins) file under/config/dns-conf - Cloudflare provides free accounts for managing dns and is very easy to use with this image. Make sure that it is set up for "dns only" instead of "dns + proxy"
- Google dns plugin is meant to be used with "Google Cloud DNS", a paid enterprise product, and not for "Google Domains DNS"
- DuckDNS only supports two types of DNS validated certificates (not both at the same time):
- Certs that only cover your main subdomain (ie.
yoursubdomain.duckdns.org, leave theSUBDOMAINSvariable empty) - Certs that cover sub-subdomains of your main subdomain (ie.
*.yoursubdomain.duckdns.org, set theSUBDOMAINSvariable towildcard)
- Certs that only cover your main subdomain (ie.
--cap-add=NET_ADMINis required for fail2ban to modify iptables- After setup, navigate to
https://yourdomain.urlto access the default homepage (http access through port 80 is disabled by default, you can enable it by editing the default site config at/config/nginx/site-confs/default.conf). - Certs are checked nightly and if expiration is within 30 days, renewal is attempted. If your cert is about to expire in less than 30 days, check the logs under
/config/log/letsencryptto see why the renewals have been failing. It is recommended to input your e-mail in docker parameters so you receive expiration notices from Let's Encrypt in those circumstances.
Security and password protection¶
- The container detects changes to url and subdomains, revokes existing certs and generates new ones during start.
- Per RFC7919, the container is shipping ffdhe4096 as the
dhparams.pem. - If you'd like to password protect your sites, you can use htpasswd. Run the following command on your host to generate the htpasswd file
docker exec -it swag htpasswd -c /config/nginx/.htpasswd <username> - You can add multiple user:pass to
.htpasswd. For the first user, use the above command, for others, use the above command without the-cflag, as it will force deletion of the existing.htpasswdand creation of a new one - You can also use ldap auth for security and access control. A sample, user configurable ldap.conf is provided, and it requires the separate image linuxserver/ldap-auth to communicate with an ldap server.
Site config and reverse proxy¶
- The default site config resides at
/config/nginx/site-confs/default.conf. Feel free to modify this file, and you can add other conf files to this directory. However, if you delete thedefaultfile, a new default will be created on container start. - Preset reverse proxy config files are added for popular apps. See the
README.mdfile under/config/nginx/proxy_confsfor instructions on how to enable them. The preset confs reside in and get imported from this repo. - If you wish to hide your site from search engine crawlers, you may find it useful to add this configuration line to your site config, within the server block, above the line where ssl.conf is included
add_header X-Robots-Tag "noindex, nofollow, nosnippet, noarchive";This will ask Google et al not to index and list your site. Be careful with this, as you will eventually be de-listed if you leave this line in on a site you wish to be present on search engines - If you wish to redirect http to https, you must expose port 80
Using certs in other containers¶
- This container includes auto-generated pfx and private-fullchain-bundle pem certs that are needed by other apps like Emby and Znc.
- To use these certs in other containers, do either of the following:
- (Easier) Mount the container's config folder in other containers (ie.
-v /path-to-swag-config:/swag-ssl) and in the other containers, use the cert location/swag-ssl/keys/letsencrypt/ - (More secure) Mount the SWAG folder
etcthat resides under/configin other containers (ie.-v /path-to-swag-config/etc:/swag-ssl) and in the other containers, use the cert location/swag-ssl/letsencrypt/live/<your.domain.url>/(This is more secure because the first method shares the entire SWAG config folder with other containers, including the www files, whereas the second method only shares the ssl certs) - These certs include:
cert.pem,chain.pem,fullchain.pemandprivkey.pem, which are generated by Certbot and used by nginx and various other appsprivkey.pfx, a format supported by Microsoft and commonly used by dotnet apps such as Emby Server (no password)priv-fullchain-bundle.pem, a pem cert that bundles the private key and the fullchain, used by apps like ZNC
Using fail2ban¶
- This container includes fail2ban set up with 5 jails by default:
- nginx-http-auth
- nginx-badbots
- nginx-botsearch
- nginx-deny
- nginx-unauthorized
- To enable or disable other jails, modify the file
/config/fail2ban/jail.local - To modify filters and actions, instead of editing the
.conffiles, create.localfiles with the same name and edit those because .conf files get overwritten when the actions and filters are updated..localfiles will append whatever's in the.conffiles (ie.nginx-http-auth.conf-->nginx-http-auth.local) - You can check which jails are active via
docker exec -it swag fail2ban-client status - You can check the status of a specific jail via
docker exec -it swag fail2ban-client status <jail name> - You can unban an IP via
docker exec -it swag fail2ban-client set <jail name> unbanip <IP> - A list of commands can be found here: https://www.fail2ban.org/wiki/index.php/Commands
Updating configs¶
- This container creates a number of configs for nginx, proxy samples, etc.
- Config updates are noted in the changelog but not automatically applied to your files.
- If you have modified a file with noted changes in the changelog:
- Keep your existing configs as is (not broken, don't fix)
- Review our repository commits and apply the new changes yourself
- Delete the modified config file with listed updates, restart the container, reapply your changes
- If you have NOT modified a file with noted changes in the changelog:
- Delete the config file with listed updates, restart the container
- Proxy sample updates are not listed in the changelog. See the changes here: https://github.com/linuxserver/reverse-proxy-confs/commits/master
- Proxy sample files WILL be updated, however your renamed (enabled) proxy files will not.
- You can check the new sample and adjust your active config as needed.
Migration from the old linuxserver/letsencrypt image¶
Please follow the instructions on this blog post.
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)¶
---
+ swag - LinuxServer.io linuxserver/swag¶
SWAG - Secure Web Application Gateway (formerly known as letsencrypt, no relation to Let's Encrypt™) sets up an Nginx webserver and reverse proxy with php support and a built-in certbot client that automates free SSL server certificate generation and renewal processes (Let's Encrypt and ZeroSSL). It also contains fail2ban for intrusion prevention.
Supported Architectures¶
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/swag:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
Validation and initial setup¶
- Before running this container, make sure that the url and subdomains are properly forwarded to this container's host, and that port 443 (and/or 80) is not being used by another service on the host (NAS gui, another webserver, etc.).
- If you need a dynamic dns provider, you can use the free provider duckdns.org where the
URL will be yoursubdomain.duckdns.org and the SUBDOMAINS can be www,ftp,cloud with http validation, or wildcard with dns validation. You can use our duckdns image to update your IP on duckdns.org. - For
http validation, port 80 on the internet side of the router should be forwarded to this container's port 80 - For
dns validation, make sure to enter your credentials into the corresponding ini (or json for some plugins) file under /config/dns-conf - Cloudflare provides free accounts for managing dns and is very easy to use with this image. Make sure that it is set up for "dns only" instead of "dns + proxy"
- Google dns plugin is meant to be used with "Google Cloud DNS", a paid enterprise product, and not for "Google Domains DNS"
- DuckDNS only supports two types of DNS validated certificates (not both at the same time):
- Certs that only cover your main subdomain (ie.
yoursubdomain.duckdns.org, leave the SUBDOMAINS variable empty) - Certs that cover sub-subdomains of your main subdomain (ie.
*.yoursubdomain.duckdns.org, set the SUBDOMAINS variable to wildcard)
--cap-add=NET_ADMIN is required for fail2ban to modify iptables- After setup, navigate to
https://yourdomain.url to access the default homepage (http access through port 80 is disabled by default, you can enable it by editing the default site config at /config/nginx/site-confs/default.conf). - Certs are checked nightly and if expiration is within 30 days, renewal is attempted. If your cert is about to expire in less than 30 days, check the logs under
/config/log/letsencrypt to see why the renewals have been failing. It is recommended to input your e-mail in docker parameters so you receive expiration notices from Let's Encrypt in those circumstances.
Security and password protection¶
- The container detects changes to url and subdomains, revokes existing certs and generates new ones during start.
- Per RFC7919, the container is shipping ffdhe4096 as the
dhparams.pem. - If you'd like to password protect your sites, you can use htpasswd. Run the following command on your host to generate the htpasswd file
docker exec -it swag htpasswd -c /config/nginx/.htpasswd <username> - You can add multiple user:pass to
.htpasswd. For the first user, use the above command, for others, use the above command without the -c flag, as it will force deletion of the existing .htpasswd and creation of a new one - You can also use ldap auth for security and access control. A sample, user configurable ldap.conf is provided, and it requires the separate image linuxserver/ldap-auth to communicate with an ldap server.
Site config and reverse proxy¶
- The default site config resides at
/config/nginx/site-confs/default.conf. Feel free to modify this file, and you can add other conf files to this directory. However, if you delete the default file, a new default will be created on container start. - Preset reverse proxy config files are added for popular apps. See the
README.md file under /config/nginx/proxy_confs for instructions on how to enable them. The preset confs reside in and get imported from this repo. - If you wish to hide your site from search engine crawlers, you may find it useful to add this configuration line to your site config, within the server block, above the line where ssl.conf is included
add_header X-Robots-Tag "noindex, nofollow, nosnippet, noarchive"; This will ask Google et al not to index and list your site. Be careful with this, as you will eventually be de-listed if you leave this line in on a site you wish to be present on search engines - If you wish to redirect http to https, you must expose port 80
Using certs in other containers¶
- This container includes auto-generated pfx and private-fullchain-bundle pem certs that are needed by other apps like Emby and Znc.
- To use these certs in other containers, do either of the following:
- (Easier) Mount the container's config folder in other containers (ie.
-v /path-to-swag-config:/swag-ssl) and in the other containers, use the cert location /swag-ssl/keys/letsencrypt/ - (More secure) Mount the SWAG folder
etc that resides under /config in other containers (ie. -v /path-to-swag-config/etc:/swag-ssl) and in the other containers, use the cert location /swag-ssl/letsencrypt/live/<your.domain.url>/ (This is more secure because the first method shares the entire SWAG config folder with other containers, including the www files, whereas the second method only shares the ssl certs) - These certs include:
cert.pem, chain.pem, fullchain.pem and privkey.pem, which are generated by Certbot and used by nginx and various other appsprivkey.pfx, a format supported by Microsoft and commonly used by dotnet apps such as Emby Server (no password)priv-fullchain-bundle.pem, a pem cert that bundles the private key and the fullchain, used by apps like ZNC
Using fail2ban¶
- This container includes fail2ban set up with 5 jails by default:
- nginx-http-auth
- nginx-badbots
- nginx-botsearch
- nginx-deny
- nginx-unauthorized
- To enable or disable other jails, modify the file
/config/fail2ban/jail.local - To modify filters and actions, instead of editing the
.conf files, create .local files with the same name and edit those because .conf files get overwritten when the actions and filters are updated. .local files will append whatever's in the .conf files (ie. nginx-http-auth.conf --> nginx-http-auth.local) - You can check which jails are active via
docker exec -it swag fail2ban-client status - You can check the status of a specific jail via
docker exec -it swag fail2ban-client status <jail name> - You can unban an IP via
docker exec -it swag fail2ban-client set <jail name> unbanip <IP> - A list of commands can be found here: https://www.fail2ban.org/wiki/index.php/Commands
Updating configs¶
- This container creates a number of configs for nginx, proxy samples, etc.
- Config updates are noted in the changelog but not automatically applied to your files.
- If you have modified a file with noted changes in the changelog:
- Keep your existing configs as is (not broken, don't fix)
- Review our repository commits and apply the new changes yourself
- Delete the modified config file with listed updates, restart the container, reapply your changes
- If you have NOT modified a file with noted changes in the changelog:
- Delete the config file with listed updates, restart the container
- Proxy sample updates are not listed in the changelog. See the changes here: https://github.com/linuxserver/reverse-proxy-confs/commits/master
- Proxy sample files WILL be updated, however your renamed (enabled) proxy files will not.
- You can check the new sample and adjust your active config as needed.
Migration from the old linuxserver/letsencrypt image¶
Please follow the instructions on this blog post.
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)¶
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 443Https port 80Http port (required for http validation and http -> https redirect)
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. URL=yourdomain.urlTop url you have control over (customdomain.com if you own it, or customsubdomain.ddnsprovider.com if dynamic dns). VALIDATION=httpCertbot validation method to use, options are http or dns (dns method also requires DNSPLUGIN variable set). SUBDOMAINS=www,Subdomains you'd like the cert to cover (comma separated, no spaces) ie. www,ftp,cloud. For a wildcard cert, set this exactly to wildcard (wildcard cert is available via dns validation only) CERTPROVIDER=Optionally define the cert provider. Set to zerossl for ZeroSSL certs (requires existing ZeroSSL account and the e-mail address entered in EMAIL env var). Otherwise defaults to Let's Encrypt. DNSPLUGIN=cloudflareRequired if VALIDATION is set to dns. Options are acmedns, aliyun, azure, bunny, cloudflare, cpanel, desec, digitalocean, directadmin, dnsimple, dnsmadeeasy, dnspod, do, domeneshop, dreamhost, duckdns, dynu, freedns, gandi, gehirn, godaddy, google, google-domains, he, hetzner, infomaniak, inwx, ionos, linode, loopia, luadns, netcup, njalla, nsone, ovh, porkbun, rfc2136, route53, sakuracloud, standalone, transip, and vultr. Also need to enter the credentials into the corresponding ini (or json for some plugins) file under /config/dns-conf. PROPAGATION=Optionally override (in seconds) the default propagation time for the dns plugins. EMAIL=Optional e-mail address used for cert expiration notifications (Required for ZeroSSL). ONLY_SUBDOMAINS=falseIf you wish to get certs only for certain subdomains, but not the main domain (main domain may be hosted on another machine and cannot be validated), set this to true EXTRA_DOMAINS=Additional fully qualified domain names (comma separated, no spaces) ie. extradomain.com,subdomain.anotherdomain.org,*.anotherdomain.org STAGING=falseSet to true to retrieve certs in staging mode. Rate limits will be much higher, but the resulting cert will not pass the browser's security test. Only to be used for testing purposes.
Volume Mappings (-v)¶
Volume Function /configAll the config files including the webroot reside here.
Miscellaneous Options¶
Parameter Function
Portainer notice¶
{% hint style="warning" %} This image utilises cap_add or sysctl to work properly. This is not implemented properly in some versions of Portainer, thus this image may not work if deployed through Portainer.
Environment variables from files (Docker secrets)¶
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
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:
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 swag /bin/bash- To monitor the logs of the container in realtime:
docker logs -f swag- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' swag- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/swag:latest
Versions¶
- 12.08.23: - Add FreeDNS plugin. Detect certbot DNS authenticators using CLI.
- 07.08.23: - Add Bunny DNS Configuration.
- 27.07.23: - Added support for dreamhost validation.
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 27.04.23: - Existing users should update: authelia-location.conf, authelia-server.conf, authentik-location.conf, authentik-server.conf - Simplify auth configs and fix Set-Cookie header bug.
- 13.04.23: - Existing users should update: nginx.conf, authelia-location.conf, authentik-location.conf, and site-confs/default.conf - Move ssl.conf include to default.conf. Remove Authorization headers in authelia. Sort proxy_set_header in authelia and authentik.
- 25.03.23: - Fix renewal post hook.
- 10.03.23: - Cleanup unused csr and keys folders. See certbot 2.3.0 release notes.
- 09.03.23: - Add Google Domains DNS support,
google-domains. - 02.03.23: - Set permissions on crontabs during init.
- 09.02.23: - Existing users should update: proxy.conf, authelia-location.conf and authelia-server.conf - Add Authentik configs, update Authelia configs.
- 06.02.23: - Add porkbun support back in.
- 21.01.23: - Unpin certbot version (allow certbot 2.x). !!BREAKING CHANGE!! We are temporarily removing the certbot porkbun plugin until a new version is released that is compatible with certbot 2.x.
- 20.01.23: - Rebase to alpine 3.17 with php8.1.
- 16.01.23: - Remove nchan module because it keeps causing crashes.
- 08.12.22: - Revamp certbot init.
- 03.12.22: - Remove defunct cloudxns plugin.
- 22.11.22: - Pin acme to the same version as certbot.
- 22.11.22: - Pin certbot to 1.32.0 until plugin compatibility improves.
- 05.11.22: - Update acmedns plugin handling.
- 06.10.22: - Switch to certbot-dns-duckdns. Update cpanel and gandi dns plugin handling. Minor adjustments to init logic.
- 05.10.22: - Use certbot file hooks instead of command line hooks
- 04.10.22: - Add godaddy and porkbun dns plugins.
- 03.10.22: - Add default_server back to default site conf's https listen.
- 22.09.22: - Added support for DO DNS validation.
- 22.09.22: - Added certbot-dns-acmedns for DNS01 validation.
- 20.08.22: - Existing users should update: nginx.conf - Rebasing to alpine 3.15 with php8. Restructure nginx configs (see changes announcement).
- 10.08.22: - Added support for Dynu DNS validation.
- 18.05.22: - Added support for Azure DNS validation.
- 09.04.22: - Added certbot-dns-loopia for DNS01 validation.
- 05.04.22: - Added support for standalone DNS validation.
- 28.03.22: - created a logfile for fail2ban nginx-unauthorized in /etc/cont-init.d/50-config
- 09.01.22: - Added a fail2ban jail for nginx unauthorized
- 21.12.21: - Fixed issue with iptables not working as expected
- 30.11.21: - Move maxmind to a new mod
- 22.11.21: - Added support for Infomaniak DNS for certificate generation.
- 20.11.21: - Added support for dnspod validation.
- 15.11.21: - Added support for deSEC DNS for wildcard certificate generation.
- 26.10.21: - Existing users should update: proxy.conf - Mitigate https://httpoxy.org/ vulnerabilities. Ref: https://www.nginx.com/blog/mitigating-the-httpoxy-vulnerability-with-nginx#Defeating-the-Attack-using-NGINX-and-NGINX-Plus
- 23.10.21: - Fix Hurricane Electric (HE) DNS validation.
- 12.10.21: - Fix deprecated LE root cert check to fix failures when using
STAGING=true, and failures in revoking. - 06.10.21: - Added support for Hurricane Electric (HE) DNS validation. Added lxml build deps.
- 01.10.21: - Check if the cert uses the old LE root cert, revoke and regenerate if necessary. Here's more info on LE root cert expiration
- 19.09.21: - Add an optional header to opt out of Google FLoC in
ssl.conf. - 17.09.21: - Mark
SUBDOMAINS var as optional. - 01.08.21: - Add support for ionos dns validation.
- 15.07.21: - Fix libmaxminddb issue due to upstream change.
- 07.07.21: - Rebase to alpine 3.14.
- 24.06.21: - Update default nginx conf folder.
- 28.05.21: - Existing users should update: authelia-server.conf - Use
resolver.conf and patch for CVE-2021-32637. - 20.05.21: - Modify resolver.conf generation to detect and ignore ipv6.
- 14.05.21: - Existing users should update: nginx.conf, ssl.conf, proxy.conf, and the default site-conf - Rework nginx.conf to be inline with alpine upstream and relocate lines from other files. Use linuxserver.io wheel index for pip packages. Switch to using ffdhe4096 for
dhparams.pem per RFC7919. Added worker_processes.conf, which sets the number of nginx workers, and resolver.conf, which sets the dns resolver. Both conf files are auto-generated only on first start and can be user modified later. - 21.04.21: - Existing users should update: authelia-server.conf and authelia-location.conf - Add remote name/email headers and pass http method.
- 12.04.21: - Add php7-gmp and php7-pecl-mailparse.
- 12.04.21: - Add support for vultr dns validation.
- 14.03.21: - Add support for directadmin dns validation.
- 12.02.21: - Clean up rust/cargo cache, which ballooned the image size in the last couple of builds.
- 10.02.21: - Fix aliyun, domeneshop, inwx and transip dns confs for existing users.
- 09.02.21: - Rebasing to alpine 3.13. Add nginx mods brotli and dav-ext. Remove nginx mods lua and lua-upstream (due to regression over the last couple of years).
- 26.01.21: - Add support for hetzner dns validation.
- 20.01.21: - Add check for ZeroSSL EAB retrieval.
- 08.01.21: - Add support for getting certs from ZeroSSL via optional
CERTPROVIDER env var. Update aliyun, domeneshop, inwx and transip dns plugins with the new plugin names. Hide donoteditthisfile.conf because users were editing it despite its name. Suppress harmless error when no proxy confs are enabled. - 03.01.21: - Existing users should update: /config/nginx/site-confs/default.conf - Add helper pages to aid troubleshooting
- 10.12.20: - Add support for njalla dns validation
- 09.12.20: - Check for template/conf updates and notify in the log. Add support for gehirn and sakuracloud dns validation.
- 01.11.20: - Add support for netcup dns validation
- 29.10.20: - Existing users should update: ssl.conf - Add frame-ancestors to Content-Security-Policy.
- 04.10.20: - Existing users should update: nginx.conf, proxy.conf, and ssl.conf - Minor cleanups and reordering.
- 20.09.20: - Existing users should update: nginx.conf - Added geoip2 configs. Added MAXMINDDB_LICENSE_KEY variable to readme.
- 08.09.20: - Add php7-xsl.
- 01.09.20: - Existing users should update: nginx.conf, proxy.conf, and various proxy samples - Global websockets across all configs.
- 03.08.20: - Initial release.
\ No newline at end of file
+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 swag /bin/bash- To monitor the logs of the container in realtime:
docker logs -f swag- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' swag- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/swag:latest
Versions¶
- 12.08.23: - Add FreeDNS plugin. Detect certbot DNS authenticators using CLI.
- 07.08.23: - Add Bunny DNS Configuration.
- 27.07.23: - Added support for dreamhost validation.
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 27.04.23: - Existing users should update: authelia-location.conf, authelia-server.conf, authentik-location.conf, authentik-server.conf - Simplify auth configs and fix Set-Cookie header bug.
- 13.04.23: - Existing users should update: nginx.conf, authelia-location.conf, authentik-location.conf, and site-confs/default.conf - Move ssl.conf include to default.conf. Remove Authorization headers in authelia. Sort proxy_set_header in authelia and authentik.
- 25.03.23: - Fix renewal post hook.
- 10.03.23: - Cleanup unused csr and keys folders. See certbot 2.3.0 release notes.
- 09.03.23: - Add Google Domains DNS support,
google-domains. - 02.03.23: - Set permissions on crontabs during init.
- 09.02.23: - Existing users should update: proxy.conf, authelia-location.conf and authelia-server.conf - Add Authentik configs, update Authelia configs.
- 06.02.23: - Add porkbun support back in.
- 21.01.23: - Unpin certbot version (allow certbot 2.x). !!BREAKING CHANGE!! We are temporarily removing the certbot porkbun plugin until a new version is released that is compatible with certbot 2.x.
- 20.01.23: - Rebase to alpine 3.17 with php8.1.
- 16.01.23: - Remove nchan module because it keeps causing crashes.
- 08.12.22: - Revamp certbot init.
- 03.12.22: - Remove defunct cloudxns plugin.
- 22.11.22: - Pin acme to the same version as certbot.
- 22.11.22: - Pin certbot to 1.32.0 until plugin compatibility improves.
- 05.11.22: - Update acmedns plugin handling.
- 06.10.22: - Switch to certbot-dns-duckdns. Update cpanel and gandi dns plugin handling. Minor adjustments to init logic.
- 05.10.22: - Use certbot file hooks instead of command line hooks
- 04.10.22: - Add godaddy and porkbun dns plugins.
- 03.10.22: - Add default_server back to default site conf's https listen.
- 22.09.22: - Added support for DO DNS validation.
- 22.09.22: - Added certbot-dns-acmedns for DNS01 validation.
- 20.08.22: - Existing users should update: nginx.conf - Rebasing to alpine 3.15 with php8. Restructure nginx configs (see changes announcement).
- 10.08.22: - Added support for Dynu DNS validation.
- 18.05.22: - Added support for Azure DNS validation.
- 09.04.22: - Added certbot-dns-loopia for DNS01 validation.
- 05.04.22: - Added support for standalone DNS validation.
- 28.03.22: - created a logfile for fail2ban nginx-unauthorized in /etc/cont-init.d/50-config
- 09.01.22: - Added a fail2ban jail for nginx unauthorized
- 21.12.21: - Fixed issue with iptables not working as expected
- 30.11.21: - Move maxmind to a new mod
- 22.11.21: - Added support for Infomaniak DNS for certificate generation.
- 20.11.21: - Added support for dnspod validation.
- 15.11.21: - Added support for deSEC DNS for wildcard certificate generation.
- 26.10.21: - Existing users should update: proxy.conf - Mitigate https://httpoxy.org/ vulnerabilities. Ref: https://www.nginx.com/blog/mitigating-the-httpoxy-vulnerability-with-nginx#Defeating-the-Attack-using-NGINX-and-NGINX-Plus
- 23.10.21: - Fix Hurricane Electric (HE) DNS validation.
- 12.10.21: - Fix deprecated LE root cert check to fix failures when using
STAGING=true, and failures in revoking. - 06.10.21: - Added support for Hurricane Electric (HE) DNS validation. Added lxml build deps.
- 01.10.21: - Check if the cert uses the old LE root cert, revoke and regenerate if necessary. Here's more info on LE root cert expiration
- 19.09.21: - Add an optional header to opt out of Google FLoC in
ssl.conf. - 17.09.21: - Mark
SUBDOMAINSvar as optional. - 01.08.21: - Add support for ionos dns validation.
- 15.07.21: - Fix libmaxminddb issue due to upstream change.
- 07.07.21: - Rebase to alpine 3.14.
- 24.06.21: - Update default nginx conf folder.
- 28.05.21: - Existing users should update: authelia-server.conf - Use
resolver.confand patch forCVE-2021-32637. - 20.05.21: - Modify resolver.conf generation to detect and ignore ipv6.
- 14.05.21: - Existing users should update: nginx.conf, ssl.conf, proxy.conf, and the default site-conf - Rework nginx.conf to be inline with alpine upstream and relocate lines from other files. Use linuxserver.io wheel index for pip packages. Switch to using ffdhe4096 for
dhparams.pemper RFC7919. Addedworker_processes.conf, which sets the number of nginx workers, andresolver.conf, which sets the dns resolver. Both conf files are auto-generated only on first start and can be user modified later. - 21.04.21: - Existing users should update: authelia-server.conf and authelia-location.conf - Add remote name/email headers and pass http method.
- 12.04.21: - Add php7-gmp and php7-pecl-mailparse.
- 12.04.21: - Add support for vultr dns validation.
- 14.03.21: - Add support for directadmin dns validation.
- 12.02.21: - Clean up rust/cargo cache, which ballooned the image size in the last couple of builds.
- 10.02.21: - Fix aliyun, domeneshop, inwx and transip dns confs for existing users.
- 09.02.21: - Rebasing to alpine 3.13. Add nginx mods brotli and dav-ext. Remove nginx mods lua and lua-upstream (due to regression over the last couple of years).
- 26.01.21: - Add support for hetzner dns validation.
- 20.01.21: - Add check for ZeroSSL EAB retrieval.
- 08.01.21: - Add support for getting certs from ZeroSSL via optional
CERTPROVIDERenv var. Update aliyun, domeneshop, inwx and transip dns plugins with the new plugin names. Hidedonoteditthisfile.confbecause users were editing it despite its name. Suppress harmless error when no proxy confs are enabled. - 03.01.21: - Existing users should update: /config/nginx/site-confs/default.conf - Add helper pages to aid troubleshooting
- 10.12.20: - Add support for njalla dns validation
- 09.12.20: - Check for template/conf updates and notify in the log. Add support for gehirn and sakuracloud dns validation.
- 01.11.20: - Add support for netcup dns validation
- 29.10.20: - Existing users should update: ssl.conf - Add frame-ancestors to Content-Security-Policy.
- 04.10.20: - Existing users should update: nginx.conf, proxy.conf, and ssl.conf - Minor cleanups and reordering.
- 20.09.20: - Existing users should update: nginx.conf - Added geoip2 configs. Added MAXMINDDB_LICENSE_KEY variable to readme.
- 08.09.20: - Add php7-xsl.
- 01.09.20: - Existing users should update: nginx.conf, proxy.conf, and various proxy samples - Global websockets across all configs.
- 03.08.20: - Initial release.
linuxserver/synclounge¶
Synclounge is a third party tool that allows you to watch Plex in sync with your friends/family, wherever you are.
Supported Architectures¶
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/synclounge:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
The web app and the server are both accessible at http://SERVERIP:8088.
Note: It is recommended to use http as the external proto with a reverse proxy due to https not working with external plex clients.
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)¶
---
+ synclounge - LinuxServer.io linuxserver/synclounge¶
Synclounge is a third party tool that allows you to watch Plex in sync with your friends/family, wherever you are.
Supported Architectures¶
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/synclounge:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
The web app and the server are both accessible at http://SERVERIP:8088.
Note: It is recommended to use http as the external proto with a reverse proxy due to https not working with external plex clients.
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:
synclounge:
@@ -20,4 +20,4 @@
--restart unless-stopped \
lscr.io/linuxserver/synclounge:latest
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 8088Web app and server port
Environment Variables (-e)¶
Env Function AUTH_LIST=plexuser1,plexuser2,email1,machineid1If set, only the users defined here and the users of the plex servers defined here will be able to access the server. Use e-mails, plex usernames and/or plex server machine ids, comma separated, no spaces. AUTOJOIN_ENABLED=falseDEPRECATED - (Still works but will be removed in the future in favor of the built-in var autojoin__room) - Set to true to let users autojoin the server and a room (specified by the AUTOJOIN_ROOM var). AUTOJOIN_ROOM=roomnameDEPRECATED - (Still works but will be removed in the future in favor of the built-in var autojoin__room) - Set the room name for auto joining (requires AUTOJOIN_ENABLED set to true).
Volume Mappings (-v)¶
Volume Function
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:
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.
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 synclounge /bin/bash- To monitor the logs of the container in realtime:
docker logs -f synclounge- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' synclounge- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/synclounge:latest
Versions¶
- 26.08.23: - Rebase to Alpine 3.18.
- 04.07.23: - Deprecate armhf. As announced here
- 29.11.22: - Rebase to alpine 3.17, upgrade to s6v3.
- 19.09.22: - Rebase to alpine 3.15.
- 12.02.21: - Fix optional dependency builds in aarch64 image.
- 12.02.21: - Rebasing to alpine 3.13.
- 28.10.20: - Update to v4. Env vars
EXTERNAL_URL, EXTERNAL_SERVER_PORT and AUTOJOIN_PASSWORD are deprecated and no longer have any effect. Env vars AUTOJOIN_ENABLED and AUTOJOIN_ROOM are still working but will be removed in the future in favor of synclounge's built-in var autojoin__room. If you are reverse proxying, do not forget to update your proxy settings (here and here) as the server port and addresses are changed. - 11.10.20: - Pin builds to upstream commit
6aecc9bd while evaluating the breaking changes upstream. - 27.09.20: - Updating the external repo endpoint.
- 01.06.20: - Rebasing to alpine 3.12.
- 11.05.20: - Initial Release.
\ No newline at end of file
+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.
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 synclounge /bin/bash- To monitor the logs of the container in realtime:
docker logs -f synclounge- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' synclounge- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/synclounge:latest
Versions¶
- 26.08.23: - Rebase to Alpine 3.18.
- 04.07.23: - Deprecate armhf. As announced here
- 29.11.22: - Rebase to alpine 3.17, upgrade to s6v3.
- 19.09.22: - Rebase to alpine 3.15.
- 12.02.21: - Fix optional dependency builds in aarch64 image.
- 12.02.21: - Rebasing to alpine 3.13.
- 28.10.20: - Update to v4. Env vars
EXTERNAL_URL,EXTERNAL_SERVER_PORTandAUTOJOIN_PASSWORDare deprecated and no longer have any effect. Env varsAUTOJOIN_ENABLEDandAUTOJOIN_ROOMare still working but will be removed in the future in favor of synclounge's built-in varautojoin__room. If you are reverse proxying, do not forget to update your proxy settings (here and here) as the server port and addresses are changed. - 11.10.20: - Pin builds to upstream commit
6aecc9bdwhile evaluating the breaking changes upstream. - 27.09.20: - Updating the external repo endpoint.
- 01.06.20: - Rebasing to alpine 3.12.
- 11.05.20: - Initial Release.
linuxserver/syncthing¶
Syncthing replaces proprietary sync and cloud services with something open, trustworthy and decentralized. Your data is your data alone and you deserve to choose where it is stored, if it is shared with some third party and how it's transmitted over the Internet.
Supported Architectures¶
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/syncthing:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
**Note: ** The Syncthing devs highly suggest setting a password for this container as it listens on 0.0.0.0. To do this go to Actions -> Settings -> set user/password for the webUI.
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)¶
---
+ syncthing - LinuxServer.io linuxserver/syncthing¶
Syncthing replaces proprietary sync and cloud services with something open, trustworthy and decentralized. Your data is your data alone and you deserve to choose where it is stored, if it is shared with some third party and how it's transmitted over the Internet.
Supported Architectures¶
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/syncthing:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
**Note: ** The Syncthing devs highly suggest setting a password for this container as it listens on 0.0.0.0. To do this go to Actions -> Settings -> set user/password for the webUI.
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)¶
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 8384Application WebUI 22000/tcpListening port (TCP) 22000/udpListening port (UDP) 21027/udpProtocol discovery
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configConfiguration files. /data1Data1 /data2Data2
Miscellaneous Options¶
Parameter Function --hostname=Optionally the hostname can be defined.
Environment variables from files (Docker secrets)¶
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
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:
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 syncthing /bin/bash- To monitor the logs of the container in realtime:
docker logs -f syncthing- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' syncthing- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/syncthing:latest
Versions¶
- 01.07.23: - Deprecate armhf. As announced here
- 13.02.23: - Rebase to Alpine 3.17, migrate to s6v3.
- 17.08.22: - Build on alpine 3.16 for go 1.18).
- 03.05.22: - Rebase to alpine 3.15 (builds on edge for go 1.18).
- 05.10.21: - Rebase to alpine 3.14.
- 12.05.21: - Remove sysctl parameter again
- 03.05.21: - Raise maximum UDP buffer size.
- 03.05.21: - Add port mapping for 22000/udp.
- 29.01.21: - Deprecate
UMASK_SET in favor of UMASK in baseimage, see above for more information. - 23.01.21: - Rebasing to alpine 3.13.
- 15.09.20: - Use go from alpine edge repo to compile. Remove duplicate UMASK env var. Add hostname setting.
- 01.06.20: - Rebasing to alpine 3.12.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 05.03.19: - Update Build process for v1.1.0 release.
- 22.02.19: - Rebasing to alpine 3.9.
- 16.01.19: - Add pipeline logic and multi arch.
- 30.07.18: - Rebase to alpine 3.8 and use buildstage.
- 13.12.17: - Rebase to alpine 3.7.
- 25.10.17: - Add env for manual setting of umask.
- 29.07.17: - Simplify build structure as symlinks failing on > 0.14.32
- 28.05.17: - Rebase to alpine 3.6.
- 08.02.17: - Rebase to alpine 3.5.
- 01.11.16: - Switch to compiling latest version from git source.
- 14.10.16: - Add version layer information.
- 30.09.16: - Fix umask.
- 09.09.16: - Add layer badges to README.
- 28.08.16: - Add badges to README.
- 11.08.16: - Rebase to alpine linux.
- 18.12.15: - Initial testing / release (IronicBadger)
- 24.09.15: - Inital dev complete (Lonix)
\ No newline at end of file
+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 syncthing /bin/bash- To monitor the logs of the container in realtime:
docker logs -f syncthing- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' syncthing- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/syncthing:latest
Versions¶
- 01.07.23: - Deprecate armhf. As announced here
- 13.02.23: - Rebase to Alpine 3.17, migrate to s6v3.
- 17.08.22: - Build on alpine 3.16 for go 1.18).
- 03.05.22: - Rebase to alpine 3.15 (builds on edge for go 1.18).
- 05.10.21: - Rebase to alpine 3.14.
- 12.05.21: - Remove sysctl parameter again
- 03.05.21: - Raise maximum UDP buffer size.
- 03.05.21: - Add port mapping for 22000/udp.
- 29.01.21: - Deprecate
UMASK_SETin favor of UMASK in baseimage, see above for more information. - 23.01.21: - Rebasing to alpine 3.13.
- 15.09.20: - Use go from alpine edge repo to compile. Remove duplicate UMASK env var. Add hostname setting.
- 01.06.20: - Rebasing to alpine 3.12.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 05.03.19: - Update Build process for v1.1.0 release.
- 22.02.19: - Rebasing to alpine 3.9.
- 16.01.19: - Add pipeline logic and multi arch.
- 30.07.18: - Rebase to alpine 3.8 and use buildstage.
- 13.12.17: - Rebase to alpine 3.7.
- 25.10.17: - Add env for manual setting of umask.
- 29.07.17: - Simplify build structure as symlinks failing on > 0.14.32
- 28.05.17: - Rebase to alpine 3.6.
- 08.02.17: - Rebase to alpine 3.5.
- 01.11.16: - Switch to compiling latest version from git source.
- 14.10.16: - Add version layer information.
- 30.09.16: - Fix umask.
- 09.09.16: - Add layer badges to README.
- 28.08.16: - Add badges to README.
- 11.08.16: - Rebase to alpine linux.
- 18.12.15: - Initial testing / release (IronicBadger)
- 24.09.15: - Inital dev complete (Lonix)
linuxserver/syslog-ng¶
syslog-ng allows you to flexibly collect, parse, classify, rewrite and correlate logs from across your infrastructure and store or route them to log analysis tools.
Supported Architectures¶
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/syslog-ng:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
Edit /config/syslog-ng.conf to configure your logging sources and destinations. Note: As the application does not run as root you cannot listen on ports < 1024.
The application pid, control file, etc. are all kept in /config so when using tools such as syslog-ng-ctl you need to specify the path e.g. syslog-ng-ctl reload -c /config/syslog-ng.ctl
More info at syslog-ng.
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)¶
---
+ syslog-ng - LinuxServer.io linuxserver/syslog-ng¶
syslog-ng allows you to flexibly collect, parse, classify, rewrite and correlate logs from across your infrastructure and store or route them to log analysis tools.
Supported Architectures¶
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/syslog-ng:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
Edit /config/syslog-ng.conf to configure your logging sources and destinations. Note: As the application does not run as root you cannot listen on ports < 1024.
The application pid, control file, etc. are all kept in /config so when using tools such as syslog-ng-ctl you need to specify the path e.g. syslog-ng-ctl reload -c /config/syslog-ng.ctl
More info at syslog-ng.
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)¶
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 5514/udpSyslog UDP 6601/tcpSyslog TCP 6514/tcpSyslog TLS
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configStores config and application files /var/logStores logs collected by the syslog-ng service
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:
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:
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 syslog-ng /bin/bash- To monitor the logs of the container in realtime:
docker logs -f syslog-ng- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' syslog-ng- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/syslog-ng:latest
Versions¶
- 11.06.23: - Rebase to Alpine 3.18, deprecate armhf.
- 10.01.23: - Add paho-mqtt-c library as required by the syslog-ng documentation
- 30.12.22: - Rebase to Alpine 3.17, add libdbi-drivers for SQL support.
- 01.10.22: - Rebase to Alpine 3.16, migrate to s6v3.
- 18.12.21: - Rebase to Alpine 3.15.
- 01.07.21: - Rebase to Alpine 3.14.
- 26.05.21: - Initial release.
\ No newline at end of file
+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 syslog-ng /bin/bash- To monitor the logs of the container in realtime:
docker logs -f syslog-ng- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' syslog-ng- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/syslog-ng:latest
Versions¶
- 11.06.23: - Rebase to Alpine 3.18, deprecate armhf.
- 10.01.23: - Add paho-mqtt-c library as required by the syslog-ng documentation
- 30.12.22: - Rebase to Alpine 3.17, add libdbi-drivers for SQL support.
- 01.10.22: - Rebase to Alpine 3.16, migrate to s6v3.
- 18.12.21: - Rebase to Alpine 3.15.
- 01.07.21: - Rebase to Alpine 3.14.
- 26.05.21: - Initial release.
DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. This project is no longer maintained for VDI please use: https://github.com/linuxserver/docker-webtop For web based docker management try: https://github.com/SelfhostedPro/Yacht https://www.portainer.io/
linuxserver/taisun¶
Taisun is an application for a Docker enabled device with an emphasis on providing a web based interface for managing a single server. Taisun allows you to:
- Deploy and manage web based virtual desktops.
- Deploy Taisun specific stacks of applications
- Browse available images on popular Docker repositories
- Import a Docker project from any git repository and start developing on your choice of web based IDE or full Linux desktop
- Spinup a developer container based on popular frameworks and work from a web based IDE
- Single click remote server access to Taisun and your Docker applications
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/taisun 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 | amd64-latest |
| arm64 | arm64v8-latest |
| armhf | arm32v7-latest |
Application Setup¶
The webui is at http://localhost:3000, for more information on usage see here.
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)¶
---
+ taisun - LinuxServer.io DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated. This project is no longer maintained for VDI please use: https://github.com/linuxserver/docker-webtop For web based docker management try: https://github.com/SelfhostedPro/Yacht https://www.portainer.io/
linuxserver/taisun¶
Taisun is an application for a Docker enabled device with an emphasis on providing a web based interface for managing a single server. Taisun allows you to:
- Deploy and manage web based virtual desktops.
- Deploy Taisun specific stacks of applications
- Browse available images on popular Docker repositories
- Import a Docker project from any git repository and start developing on your choice of web based IDE or full Linux desktop
- Spinup a developer container based on popular frameworks and work from a web based IDE
- Single click remote server access to Taisun and your Docker applications
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/taisun 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 amd64-latest arm64 arm64v8-latest armhf arm32v7-latest
Application Setup¶
The webui is at http://localhost:3000, for more information on usage see here.
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"
services:
taisun:
@@ -17,4 +17,4 @@
--restart unless-stopped \
lscr.io/linuxserver/taisun
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 3000Taisun WebUI.
Environment Variables (-e)¶
Env Function
Volume Mappings (-v)¶
Volume Function /var/run/docker.sockDocker Socket on the system
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:
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.
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 taisun /bin/bash- To monitor the logs of the container in realtime:
docker logs -f taisun- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' taisun- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/taisun
Versions¶
- 02.02.22: - Deprecate.
- 23.01.21: - Rebasing to alpine 3.13.
- 02.06.20: - Rebasing to alpine 3.12.
- 19.12.19: - Rebasing to alpine 3.11.
- 20.07.19: - Build compose bins from source, use minimal docker install from repos.
- 28.06.19: - Rebasing to alpine 3.10.
- 30.03.19: - Updating docker-compose build dependancies for musl libc.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 13.02.19: - Initial release.
\ No newline at end of file
+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.
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 taisun /bin/bash- To monitor the logs of the container in realtime:
docker logs -f taisun- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' taisun- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/taisun
Versions¶
- 02.02.22: - Deprecate.
- 23.01.21: - Rebasing to alpine 3.13.
- 02.06.20: - Rebasing to alpine 3.12.
- 19.12.19: - Rebasing to alpine 3.11.
- 20.07.19: - Build compose bins from source, use minimal docker install from repos.
- 28.06.19: - Rebasing to alpine 3.10.
- 30.03.19: - Updating docker-compose build dependancies for musl libc.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 13.02.19: - Initial release.
linuxserver/tautulli¶
Tautulli is a python based web application for monitoring, analytics and notifications for Plex Media Server.
Supported Architectures¶
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/tautulli:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
| Tag | Available | Description |
|---|---|---|
| latest | ✅ | Stable Tautulli releases |
| develop | ✅ | Built at head of Tautulli nightly branch |
| ## Application Setup |
Access the webui at <your-ip>:8181, for more information check out Tautulli. To use the build-in Plex LogViewer you have to add a volume, preferably ReadOnly. Then in tautulli gui settings, under Plex Media Server, turn on Show Advanced and set the Logs Folder to the folder you mapped.
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)¶
---
+ tautulli - LinuxServer.io linuxserver/tautulli¶
Tautulli is a python based web application for monitoring, analytics and notifications for Plex Media Server.
Supported Architectures¶
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/tautulli:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
Tag Available Description latest ✅ Stable Tautulli releases develop ✅ Built at head of Tautulli nightly branch ## Application Setup
Access the webui at <your-ip>:8181, for more information check out Tautulli. To use the build-in Plex LogViewer you have to add a volume, preferably ReadOnly. Then in tautulli gui settings, under Plex Media Server, turn on Show Advanced and set the Logs Folder to the folder you mapped.
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)¶
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 8181WebUI
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configContains tautulli config and database.
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:
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:
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 tautulli /bin/bash- To monitor the logs of the container in realtime:
docker logs -f tautulli- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' tautulli- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/tautulli:latest
Versions¶
- 26.08.23: - Rebase to Alpine 3.18.
- 22.06.23: - Revert master branch to Alpine 3.17 due to issues with Python 3.11.
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 15.12.22: - Rebase master branch to Alpine 3.17.
- 04.10.22: - Rebase master branch to Alpine 3.16, migrate to s6v3.
- 10.01.22: - Rebase to Alpine 3.15.
- 11.07.21: - Add curl package.
- 23.01.21: - Rebasing to alpine 3.13.
- 11.07.20: - Add py3-openssl.
- 05.06.20: - Rebasing to alpine 3.12. Rework to python3.
- 12.04.20: - Added mock from pip and donate links.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebasing to alpine 3.9.
- 26.01.19: - Add pipeline logic and multi arch.
- 23.10.18: - Update plex logs info in readm.
- 16.08.18: - Rebase to alpine 3.8.
- 10.03.18: - Rebrand to tautulli.
- 12.12.17: - Rebase to alpine 3.7.
- 21.07.17: - Internal git pull instead of at runtime.
- 12.07.17: - Add inspect commands to README, move to jenkins build and push.
- 25.05.17: - Rebase to alpine 3.6.
- 20.04.17: - Add pycryptodomex pip package.
- 07.02.17: - Rebase to alpine 3.5.
- 09.09.16: - Add layer badges to README.
- 27.08.16: - Add badges to README.
- 08.08.16: - Rebase to alpine linux.
- 16.07.15: - Inital Release.
\ No newline at end of file
+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 tautulli /bin/bash- To monitor the logs of the container in realtime:
docker logs -f tautulli- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' tautulli- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/tautulli:latest
Versions¶
- 26.08.23: - Rebase to Alpine 3.18.
- 22.06.23: - Revert master branch to Alpine 3.17 due to issues with Python 3.11.
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 15.12.22: - Rebase master branch to Alpine 3.17.
- 04.10.22: - Rebase master branch to Alpine 3.16, migrate to s6v3.
- 10.01.22: - Rebase to Alpine 3.15.
- 11.07.21: - Add curl package.
- 23.01.21: - Rebasing to alpine 3.13.
- 11.07.20: - Add py3-openssl.
- 05.06.20: - Rebasing to alpine 3.12. Rework to python3.
- 12.04.20: - Added mock from pip and donate links.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebasing to alpine 3.9.
- 26.01.19: - Add pipeline logic and multi arch.
- 23.10.18: - Update plex logs info in readm.
- 16.08.18: - Rebase to alpine 3.8.
- 10.03.18: - Rebrand to tautulli.
- 12.12.17: - Rebase to alpine 3.7.
- 21.07.17: - Internal git pull instead of at runtime.
- 12.07.17: - Add inspect commands to README, move to jenkins build and push.
- 25.05.17: - Rebase to alpine 3.6.
- 20.04.17: - Add pycryptodomex pip package.
- 07.02.17: - Rebase to alpine 3.5.
- 09.09.16: - Add layer badges to README.
- 27.08.16: - Add badges to README.
- 08.08.16: - Rebase to alpine linux.
- 16.07.15: - Inital Release.
DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated.
linuxserver/tester¶
This internal tool is used as a desktop sandbox in our CI process to grab a screenshot of a hopefully functional endpoint
Supported Architectures¶
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/tester:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ❌ | |
| armhf | ❌ |
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)¶
---
+ tester - LinuxServer.io DEPRECATION NOTICE¶
This image is deprecated. We will not offer support for this image and it will not be updated.
linuxserver/tester¶
This internal tool is used as a desktop sandbox in our CI process to grab a screenshot of a hopefully functional endpoint
Supported Architectures¶
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/tester:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ❌ armhf ❌
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:
tester:
@@ -16,4 +16,4 @@
--restart unless-stopped \
lscr.io/linuxserver/tester:latest
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 3000WebUI
Environment Variables (-e)¶
Env Function URL=http://google.comSpecify an endpoint, the container will automatically determine the correct protocol and program to use
Volume Mappings (-v)¶
Volume Function
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:
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.
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 tester /bin/bash- To monitor the logs of the container in realtime:
docker logs -f tester- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' tester- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/tester:latest
Versions¶
- 25.04.23: - Deprecate.
- 16.04.23: - User Chromium image as base.
- 16.11.22: - Revert the rdesktop baseimage's sesman change that introduced a delay.
- 24.10.22: - Rebase to Alpine 3.16, migrate to s6v3.
- 18.04.20: - Initial release.
\ No newline at end of file
+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.
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 tester /bin/bash- To monitor the logs of the container in realtime:
docker logs -f tester- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' tester- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/tester:latest
Versions¶
- 25.04.23: - Deprecate.
- 16.04.23: - User Chromium image as base.
- 16.11.22: - Revert the rdesktop baseimage's sesman change that introduced a delay.
- 24.10.22: - Rebase to Alpine 3.16, migrate to s6v3.
- 18.04.20: - Initial release.
linuxserver/thelounge¶
Thelounge (a fork of shoutIRC) is a web IRC client that you host on your own server.
Supported Architectures¶
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/thelounge:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
| Tag | Available | Description |
|---|---|---|
| latest | ✅ | Stable releases. |
| next | ✅ | Next Pre-Releases. |
| nightly | ✅ | Nightly images from commits in master. |
| ## Application Setup |
-
When the application first runs, it will populate its /config
-
Stop the container
-
Now from the host, edit
/config/config.js, wherever you've mapped it -
In most cases you want the value
public: falseto allow named users only -
Setting the two prefetch values to true improves usability, but uses more storage
-
Once you have the configuration you want, save it and start the container again
-
For each user, run the command
-
docker exec -it thelounge s6-setuidgid abc thelounge add <user> -
You will be prompted to enter a password that will not be echoed.
-
Saving logs to disk is the default, this consumes more space but allows scrollback.
-
To log in to the application, browse to
http://<hostip>:9000 -
You should now be prompted for a username and password on the webinterface.
-
Once logged in, you can add an IRC network. Some defaults are preset for Freenode
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)¶
---
+ thelounge - LinuxServer.io linuxserver/thelounge¶
Thelounge (a fork of shoutIRC) is a web IRC client that you host on your own server.
Supported Architectures¶
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/thelounge:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
Tag Available Description latest ✅ Stable releases. next ✅ Next Pre-Releases. nightly ✅ Nightly images from commits in master. ## Application Setup
-
When the application first runs, it will populate its /config
-
Stop the container
-
Now from the host, edit /config/config.js, wherever you've mapped it
-
In most cases you want the value public: false to allow named users only
-
Setting the two prefetch values to true improves usability, but uses more storage
-
Once you have the configuration you want, save it and start the container again
-
For each user, run the command
-
docker exec -it thelounge s6-setuidgid abc thelounge add <user>
-
You will be prompted to enter a password that will not be echoed.
-
Saving logs to disk is the default, this consumes more space but allows scrollback.
-
To log in to the application, browse to http://<hostip>:9000
-
You should now be prompted for a username and password on the webinterface.
-
Once logged in, you can add an IRC network. Some defaults are preset for Freenode
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)¶
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 9000Application WebUI
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configConfiguration files.
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:
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:
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 thelounge /bin/bash- To monitor the logs of the container in realtime:
docker logs -f thelounge- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' thelounge- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/thelounge:latest
Versions¶
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 18.12.22: - Rebasing master to alpine 3.17.
- 24.10.22: - Fix sqlite3 build.
- 12.04.22: - Install from source using yarn.
- 11.04.22: - Rebasing to alpine 3.15 and switching from python2-dev to python3-dev for building node sqlite on arm.
- 23.01.21: - Rebasing to alpine 3.13.
- 02.06.20: - Rebasing to alpine 3.12.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 15.05.19: - Update Arm variant images to build sqlite3 module.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebasing to alpine 3.9.
- 28.01.19: - Add pipeline logic and multi arch.
- 25.08.18: - Use global install, simplifies adding users.
- 20.08.18: - Rebase to alpine 3.8.
- 06.01.18: - Rebase to alpine 3.7.
- 26.05.17: - Rebase to alpine 3.6.
- 06.02.17: - Rebase to alpine 3.5.
- 14.10.16: - Bump to pickup 2.10 release.
- 14.10.16: - Add version layer information.
- 11.09.16: - Add layer badges to README.
- 31.08.16: - Initial Release.
\ No newline at end of file
+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 thelounge /bin/bash- To monitor the logs of the container in realtime:
docker logs -f thelounge- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' thelounge- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/thelounge:latest
Versions¶
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 18.12.22: - Rebasing master to alpine 3.17.
- 24.10.22: - Fix sqlite3 build.
- 12.04.22: - Install from source using yarn.
- 11.04.22: - Rebasing to alpine 3.15 and switching from python2-dev to python3-dev for building node sqlite on arm.
- 23.01.21: - Rebasing to alpine 3.13.
- 02.06.20: - Rebasing to alpine 3.12.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 15.05.19: - Update Arm variant images to build sqlite3 module.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebasing to alpine 3.9.
- 28.01.19: - Add pipeline logic and multi arch.
- 25.08.18: - Use global install, simplifies adding users.
- 20.08.18: - Rebase to alpine 3.8.
- 06.01.18: - Rebase to alpine 3.7.
- 26.05.17: - Rebase to alpine 3.6.
- 06.02.17: - Rebase to alpine 3.5.
- 14.10.16: - Bump to pickup 2.10 release.
- 14.10.16: - Add version layer information.
- 11.09.16: - Add layer badges to README.
- 31.08.16: - Initial Release.
linuxserver/transmission¶
Transmission is designed for easy, powerful use. Transmission has the features you want from a BitTorrent client: encryption, a web interface, peer exchange, magnet links, DHT, µTP, UPnP and NAT-PMP port forwarding, webseed support, watch directories, tracker editing, global and per-torrent speed limits, and more.
Supported Architectures¶
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/transmission:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
Webui is on port 9091, the settings.json file in /config has extra settings not available in the webui. Stop the container before editing it or any changes won't be saved.
Securing the webui with a username/password.¶
Use the USER and PASS variables in docker run/create/compose to set authentication. Do not manually edit the settings.json to input user/pass, otherwise transmission cannot be stopped cleanly by the s6 supervisor.
Updating Blocklists Automatically¶
This requires "blocklist-enabled": true, to be set. By setting this to true, it is assumed you have also populated blocklist-url with a valid block list.
The automatic update is a shell script that downloads a blocklist from the url stored in the settings.json, gunzips it, and restarts the transmission daemon.
The automatic update will run once a day at 3am local server time.
Using whitelist¶
Use WHITELIST to enable a list of ip as whitelist. This enable support for rpc-whitelist. When WHITELIST is empty support for whitelist is disabled.
Use HOST_WHITELIST to enable an list of dns names as host-whitelist. This enable support for rpc-host-whitelist. When HOST_WHITELIST is empty support for host-whitelist is disabled.
Use alternative Transmission torrent ports¶
Use PEERPORT to specify the port(s) Transmission should listen on. This disables random port selection. This should be the same as the port mapped in your docker configuration.
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)¶
---
+ transmission - LinuxServer.io linuxserver/transmission¶
Transmission is designed for easy, powerful use. Transmission has the features you want from a BitTorrent client: encryption, a web interface, peer exchange, magnet links, DHT, µTP, UPnP and NAT-PMP port forwarding, webseed support, watch directories, tracker editing, global and per-torrent speed limits, and more.
Supported Architectures¶
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/transmission:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
Webui is on port 9091, the settings.json file in /config has extra settings not available in the webui. Stop the container before editing it or any changes won't be saved.
Securing the webui with a username/password.¶
Use the USER and PASS variables in docker run/create/compose to set authentication. Do not manually edit the settings.json to input user/pass, otherwise transmission cannot be stopped cleanly by the s6 supervisor.
Updating Blocklists Automatically¶
This requires "blocklist-enabled": true, to be set. By setting this to true, it is assumed you have also populated blocklist-url with a valid block list.
The automatic update is a shell script that downloads a blocklist from the url stored in the settings.json, gunzips it, and restarts the transmission daemon.
The automatic update will run once a day at 3am local server time.
Using whitelist¶
Use WHITELIST to enable a list of ip as whitelist. This enable support for rpc-whitelist. When WHITELIST is empty support for whitelist is disabled.
Use HOST_WHITELIST to enable an list of dns names as host-whitelist. This enable support for rpc-host-whitelist. When HOST_WHITELIST is empty support for host-whitelist is disabled.
Use alternative Transmission torrent ports¶
Use PEERPORT to specify the port(s) Transmission should listen on. This disables random port selection. This should be the same as the port mapped in your docker configuration.
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)¶
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 9091WebUI 51413Torrent Port TCP 51413/udpTorrent Port UDP
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. TRANSMISSION_WEB_HOME=Specify the path to an alternative UI folder. USER=Specify an optional username for the interface PASS=Specify an optional password for the interface WHITELIST=Specify an optional list of comma separated ip whitelist. Fills rpc-whitelist setting. PEERPORT=Specify an optional port for torrent TCP/UDP connections. Fills peer-port setting. HOST_WHITELIST=Specify an optional list of comma separated dns name whitelist. Fills rpc-host-whitelist setting.
Volume Mappings (-v)¶
Volume Function /configWhere transmission should store config files and logs. /downloadsLocal path for downloads. /watchWatch folder for torrent files.
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:
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:
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 transmission /bin/bash- To monitor the logs of the container in realtime:
docker logs -f transmission- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' transmission- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/transmission:latest
Versions¶
- 10.08.23: - Bump unrar to 6.2.10.
- 10.06.23: - Bump unrar to 6.2.8, install transmission-extra.
- 25.05.23: - Deprecate armhf.
- 14.05.23: - Explicitly install transmission-remote.
- 02.03.23: - Add cron init to allow user customizable crontabs.
- 08.02.23: - Rebase to Alpine Edge to get access to most up to date builds of Transmission. Remove bundled 3rd party UI packages.
- 05.01.23: - Rebase to Alpine 3.17, restore GNU findutils package.
- 02.11.22: - Rebase to Alpine 3.16, migrate to s6v3.
- 12.08.22: - Bump unrar to 6.1.7.
- 03.04.22: - Add Transmissionic as a UI option.
- 21.02.22: - Build unrar from source, rebase to Alpine 3.15, add symlinks neeeded for TWC. Credit @alexbelgium
- 09.07.21: - Wait for the transmission-daemon termination after a caught sigterm.
- 06.03.21: - Add Flood for Transmission as a UI option.
- 23.01.21: - Rebasing to alpine 3.13.
- 02.11.20: - Add ca-certificates package to allow connecting to https trackers.
- 02.06.20: - Rebase to alpine 3.12, update to transmission 3.0, remove python2, add python3.
- 11.05.20: - Remove unnecessary chmod (remnant of previous change).
- 28.04.20: - Use transmission-remote to update blocklist.
- 30.03.20: - Internalize blocklist-update.sh.
- 29.03.20: - Update auth info in readme.
- 19.12.19: - Rebasing to alpine 3.11.
- 04.10.19: - Update package label.
- 21.08.19: - Add optional user/pass environment variables, fix transmission shut down if user/pass are set.
- 19.07.19: - Send SIGTERM in blocklist update to properly close pid.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebase to Alpine 3.9, add themes to baseimage, add python and findutils.
- 22.02.19: - Catch term and clean exit.
- 07.02.19: - Add pipeline logic and multi arch.
- 15.08.18: - Rebase to alpine linux 3.8.
- 12.02.18: - Pull transmission from edge repo.
- 10.01.18: - Rebase to alpine linux 3.7.
- 25.07.17: - Add rsync package.
- 27.05.17: - Rebase to alpine linux 3.6.
- 06.02.17: - Rebase to alpine linux 3.5.
- 15.01.17: - Add p7zip, tar, unrar, and unzip packages.
- 16.10.16: - Blocklist autoupdate with optional authentication.
- 14.10.16: - Add version layer informationE.
- 23.09.16: - Add information about securing the webui to README.
- 21.09.16: - Add curl package.
- 09.09.16: - Add layer badges to README.
- 28.08.16: - Add badges to README.
- 09.08.16: - Rebase to alpine linux.
- 06.12.15: - Separate mapping for watch folder.
- 16.11.15: - Initial Release.
\ No newline at end of file
+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 transmission /bin/bash- To monitor the logs of the container in realtime:
docker logs -f transmission- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' transmission- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/transmission:latest
Versions¶
- 10.08.23: - Bump unrar to 6.2.10.
- 10.06.23: - Bump unrar to 6.2.8, install transmission-extra.
- 25.05.23: - Deprecate armhf.
- 14.05.23: - Explicitly install transmission-remote.
- 02.03.23: - Add cron init to allow user customizable crontabs.
- 08.02.23: - Rebase to Alpine Edge to get access to most up to date builds of Transmission. Remove bundled 3rd party UI packages.
- 05.01.23: - Rebase to Alpine 3.17, restore GNU findutils package.
- 02.11.22: - Rebase to Alpine 3.16, migrate to s6v3.
- 12.08.22: - Bump unrar to 6.1.7.
- 03.04.22: - Add Transmissionic as a UI option.
- 21.02.22: - Build unrar from source, rebase to Alpine 3.15, add symlinks neeeded for TWC. Credit @alexbelgium
- 09.07.21: - Wait for the transmission-daemon termination after a caught sigterm.
- 06.03.21: - Add Flood for Transmission as a UI option.
- 23.01.21: - Rebasing to alpine 3.13.
- 02.11.20: - Add ca-certificates package to allow connecting to https trackers.
- 02.06.20: - Rebase to alpine 3.12, update to transmission 3.0, remove python2, add python3.
- 11.05.20: - Remove unnecessary chmod (remnant of previous change).
- 28.04.20: - Use transmission-remote to update blocklist.
- 30.03.20: - Internalize blocklist-update.sh.
- 29.03.20: - Update auth info in readme.
- 19.12.19: - Rebasing to alpine 3.11.
- 04.10.19: - Update package label.
- 21.08.19: - Add optional user/pass environment variables, fix transmission shut down if user/pass are set.
- 19.07.19: - Send SIGTERM in blocklist update to properly close pid.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebase to Alpine 3.9, add themes to baseimage, add python and findutils.
- 22.02.19: - Catch term and clean exit.
- 07.02.19: - Add pipeline logic and multi arch.
- 15.08.18: - Rebase to alpine linux 3.8.
- 12.02.18: - Pull transmission from edge repo.
- 10.01.18: - Rebase to alpine linux 3.7.
- 25.07.17: - Add rsync package.
- 27.05.17: - Rebase to alpine linux 3.6.
- 06.02.17: - Rebase to alpine linux 3.5.
- 15.01.17: - Add p7zip, tar, unrar, and unzip packages.
- 16.10.16: - Blocklist autoupdate with optional authentication.
- 14.10.16: - Add version layer informationE.
- 23.09.16: - Add information about securing the webui to README.
- 21.09.16: - Add curl package.
- 09.09.16: - Add layer badges to README.
- 28.08.16: - Add badges to README.
- 09.08.16: - Rebase to alpine linux.
- 06.12.15: - Separate mapping for watch folder.
- 16.11.15: - Initial Release.
linuxserver/tvheadend¶
Tvheadend works as a proxy server: is a TV streaming server and recorder for Linux, FreeBSD and Android supporting DVB-S, DVB-S2, DVB-C, DVB-T, ATSC, ISDB-T, IPTV, SAT>IP and HDHomeRun as input sources. Tvheadend offers the HTTP (VLC, MPlayer), HTSP (Kodi, Movian) and SAT>IP streaming. Multiple EPG sources are supported (over-the-air DVB and ATSC including OpenTV DVB extensions, XMLTV, PyXML).
Supported Architectures¶
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/tvheadend:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
The setup depends if you run the one of the stable tags or use latest. Running latest is the easiest as it has a setup wizard.
Stable
First thing to do is to go to Configuration --> DVB Inputs --> TV adapters and add your LNB/switch info. Then create a new network in the Networks tab and set the correct pre-defined muxes and orbital position. Go back to the TV adapters tab and add the newly created network under universal LNB. Go back to the Networks tab and mark the network you created earlier and press the Force Scan button. Tvheadend will now scan the muxes for services.
After the scan is done, head to the Services tab and find the services you want as channels, mark them, and press map services. They should now appear under Configuration --> Channel/EPG.
Latest
The first thing to do is to run the setup wizard. If it doesn't pop up at first login, you can find it in Configuration --> General --> Base and click Start Wizard. This will guide you to set up the basic parts of tvheadend.
Configuring XMLTV grabber
To configure the XMLTV grabber, first check if your grabber is listed in Configuration --> Channel/EPG --> EPG Grabber Modules. If it's listed, you will have to configure the grabber before enabling. Find the path in the path field of your grabber. We will use the last part. It starts with tv_grab_. Add it after /usr/bin/ in the below command. There should be no space between Usr/bin/ and the part you added.
docker exec -it -u abc tvheadend /usr/bin/for_you_to_fill_out --configure
+ tvheadend - LinuxServer.io linuxserver/tvheadend¶
Tvheadend works as a proxy server: is a TV streaming server and recorder for Linux, FreeBSD and Android supporting DVB-S, DVB-S2, DVB-C, DVB-T, ATSC, ISDB-T, IPTV, SAT>IP and HDHomeRun as input sources. Tvheadend offers the HTTP (VLC, MPlayer), HTSP (Kodi, Movian) and SAT>IP streaming. Multiple EPG sources are supported (over-the-air DVB and ATSC including OpenTV DVB extensions, XMLTV, PyXML).
Supported Architectures¶
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/tvheadend:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
The setup depends if you run the one of the stable tags or use latest. Running latest is the easiest as it has a setup wizard.
Stable
First thing to do is to go to Configuration --> DVB Inputs --> TV adapters and add your LNB/switch info. Then create a new network in the Networks tab and set the correct pre-defined muxes and orbital position. Go back to the TV adapters tab and add the newly created network under universal LNB. Go back to the Networks tab and mark the network you created earlier and press the Force Scan button. Tvheadend will now scan the muxes for services.
After the scan is done, head to the Services tab and find the services you want as channels, mark them, and press map services. They should now appear under Configuration --> Channel/EPG.
Latest
The first thing to do is to run the setup wizard. If it doesn't pop up at first login, you can find it in Configuration --> General --> Base and click Start Wizard. This will guide you to set up the basic parts of tvheadend.
Configuring XMLTV grabber
To configure the XMLTV grabber, first check if your grabber is listed in Configuration --> Channel/EPG --> EPG Grabber Modules. If it's listed, you will have to configure the grabber before enabling. Find the path in the path field of your grabber. We will use the last part. It starts with tv_grab_. Add it after /usr/bin/ in the below command. There should be no space between Usr/bin/ and the part you added.
Now follow the onscreen progress. If you get asked about cache, just accept the default. After you have configured your grabber, you can go back and enable your grabber.
If you allready have a configuration file, you can add it in the .xmltv folder where you mapped the /config volume. If it's not created, create it.
Comskip This container comes with Comskip for commercial flagging of recordings. This you have to add in the recording config of tvheadend. Go to Configuration --> Recording. Change the view level to advanced in the top right corner, and add the below in the Post-processor command field.
Now comskip will run after each recording is finished. You will find comskip.ini in the comskip folder of your /config volume mapping. See the Comskip homepage for tuning of the ini file.
FFmpeg
FFmpeg is installed in /usr/bin/ in case you need to use it with pipe.
EPG XML file
If you have EPG data in XML format from a supplier, you can drop it in the data folder of your /config volume mapping. If it doesn't exist, create it. Then choose the XML file grabber in Configuration --> Channel/EPG --> EPG Grabber Modules. If you use WebGrab+Plus, choose the WebGrab+Plus XML file grabber. The XML file goes in the same path as above. The xml file has to be named guide.xml.
For advanced setup of tvheadend, go to [Tvheadend][appurl]
Picons
We have added all the picons from picons in the folder /picons. To enable the use of these picons, add the path to the Channel icon path in Configuration --> General --> Base. You need to enable minimum advanced view level to see the picons options.
Additional runtime parameters¶
In some cases it might be necessary to start tvheadend with additional parameters, for example to enable debugging or specify webroot for reverse proxy. Be sure to have the right parameters set, as adding the wrong once might lead to the container not starting correctly.
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)¶
Host vs. Bridge¶
If you use IPTV, SAT>IP or HDHomeRun, you need to create the container with --net=host and remove the -p flags. This is because to work with these services Tvheadend requires a multicast address of 239.255.255.250 and a UDP port of 1900 which at this time is not possible with docker bridge mode. If you have other host services which also use multicast such as SSDP/DLNA/Emby you may experience stabilty problems. These can be solved by giving tvheadend its own IP using macvlan.
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 9981WebUI 9982HTSP server port.
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. RUN_OPTS=Optionally specify additional arguments to be passed. See Additional runtime parameters.
Volume Mappings (-v)¶
Volume Function /configWhere TVHeadend show store it's config files. /recordingsWhere you want the PVR to store recordings.
Device Mappings (--device)¶
Parameter Function /dev/driOnly needed if you want to use your AMD/Intel GPU for hardware accelerated video encoding (vaapi). /dev/dvbOnly needed if you want to pass through a DVB card to the container. If you use IPTV or HDHomeRun you can leave it out.
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:
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:
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 tvheadend /bin/bash- To monitor the logs of the container in realtime:
docker logs -f tvheadend- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' tvheadend- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/tvheadend:latest
Versions¶
- 18.05.23: - Install XMLTV from Alpine repos.
- 18.05.23: - Rebase to Alpine 3.18.
- 17.03.23: - Extract picons during build instead of init.
- 23.02.23: - Rebase to Alpine 3.17, migrate to s6v3, drop armhf support.
- 31.08.22: - Update sample env vars and how RUN_OPTS are handled.
- 19.08.22: - Switch to new picons builder.
- 16.04.22: - Added URL XMLTV grabber.
- 05.01.22: - Rebase to Alpine 3.15. Disable execinfo to fix builds. Update xmltv.
- 11.05.21: - Added Intel iHD driver support.
- 02.06.20: - Update to Alpine 3.12.
- 27.12.19: - Add requests and perl-json-xs package.
- 27.12.19: - Update to Alpine 3.11.
- 02.10.19: - Improve permission fixing on render & dvb devices.
- 18.08.19: - Add AMD drivers.
- 02.08.19: - Attempt to automatically fix permissions on /dev/dri and /dev/dvb.
- 28.06.19: - Rebasing to alpine 3.10.
- 27.03.19: - Rebase to Alpine 3.9, fix init logic to only chown once.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 01.03.19: - Bump xmltv to 0.6.1.
- 28.02.19: - add perl-lwp-useragent-determined.
- 17.02.19: - Bump xmltv to 5.70, ensure version tagging works by cloning tvheadend.
- 14.02.19: - Add picons path to config.
- 15.01.19: - Add pipeline logic and multi arch.
- 12.09.18: - Rebase to alpine 3.8 and use buildstage type build.
- 21.04.18: - Add JSON::XS Perl package for grab_tv_huro.
- 24.03.18: - Add dvbcsa package.
- 04.03.18: - Use sourceforge master rather than mirror for xmltv.
- 22.02.18: - Add lost libva-intel-driver.
- 21.02.18: - Fix wrong version of iconv used.
- 18.02.18: - Add vaapi support, some cleanup and dropping of deprecated options.
- 04.01.18: - Deprecate cpu_core routine lack of scaling.
- 11.12.17: - Rebase to alpine 3.7, linting fixes.
- 02.09.17: - Add codec dependencies.
- 13.07.17: - Increase uniformity across all archs.
- 08.07.17: - Update README with full path for comskip.
- 02.07.17: - Move to one branch for all 4.2 releases.
- 27.05.17: - Rebase to alpine 3.6.
- 01.05.17: - Update to tvheadend 4.2.1 stable.
- 18.04.17: - Use repo version of gnu-libiconv rather than compiling.
- 09.04.17: - Chain cpanm installs in one block and use --installdeps.
- 09.02.17: - Perl changes, add picons file to gitignore and update XMLTV to 0.5.69.
- 07.02.17: - Add variable to add additional runtime paramters.
- 05.02.17: - Update to alpine 3.5 and change dvb-apps to only compile needed libs.
- 14.11.16: - Add picons from picons.xyz to /picons folder and add info to README.
- 22.09.16: - Fix broken tv_grab_wg, libs for xmltv and update README.
- 18.09.16: - Update XMLTV to 0.5.68 and update README.
- 10.09.16: - Add layer badges to README.
- 05.09.16: - Initial Release.
\ No newline at end of file
+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 tvheadend /bin/bash- To monitor the logs of the container in realtime:
docker logs -f tvheadend- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' tvheadend- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/tvheadend:latest
Versions¶
- 18.05.23: - Install XMLTV from Alpine repos.
- 18.05.23: - Rebase to Alpine 3.18.
- 17.03.23: - Extract picons during build instead of init.
- 23.02.23: - Rebase to Alpine 3.17, migrate to s6v3, drop armhf support.
- 31.08.22: - Update sample env vars and how RUN_OPTS are handled.
- 19.08.22: - Switch to new picons builder.
- 16.04.22: - Added URL XMLTV grabber.
- 05.01.22: - Rebase to Alpine 3.15. Disable execinfo to fix builds. Update xmltv.
- 11.05.21: - Added Intel iHD driver support.
- 02.06.20: - Update to Alpine 3.12.
- 27.12.19: - Add requests and perl-json-xs package.
- 27.12.19: - Update to Alpine 3.11.
- 02.10.19: - Improve permission fixing on render & dvb devices.
- 18.08.19: - Add AMD drivers.
- 02.08.19: - Attempt to automatically fix permissions on /dev/dri and /dev/dvb.
- 28.06.19: - Rebasing to alpine 3.10.
- 27.03.19: - Rebase to Alpine 3.9, fix init logic to only chown once.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 01.03.19: - Bump xmltv to 0.6.1.
- 28.02.19: - add perl-lwp-useragent-determined.
- 17.02.19: - Bump xmltv to 5.70, ensure version tagging works by cloning tvheadend.
- 14.02.19: - Add picons path to config.
- 15.01.19: - Add pipeline logic and multi arch.
- 12.09.18: - Rebase to alpine 3.8 and use buildstage type build.
- 21.04.18: - Add JSON::XS Perl package for grab_tv_huro.
- 24.03.18: - Add dvbcsa package.
- 04.03.18: - Use sourceforge master rather than mirror for xmltv.
- 22.02.18: - Add lost libva-intel-driver.
- 21.02.18: - Fix wrong version of iconv used.
- 18.02.18: - Add vaapi support, some cleanup and dropping of deprecated options.
- 04.01.18: - Deprecate cpu_core routine lack of scaling.
- 11.12.17: - Rebase to alpine 3.7, linting fixes.
- 02.09.17: - Add codec dependencies.
- 13.07.17: - Increase uniformity across all archs.
- 08.07.17: - Update README with full path for comskip.
- 02.07.17: - Move to one branch for all 4.2 releases.
- 27.05.17: - Rebase to alpine 3.6.
- 01.05.17: - Update to tvheadend 4.2.1 stable.
- 18.04.17: - Use repo version of gnu-libiconv rather than compiling.
- 09.04.17: - Chain cpanm installs in one block and use --installdeps.
- 09.02.17: - Perl changes, add picons file to gitignore and update XMLTV to 0.5.69.
- 07.02.17: - Add variable to add additional runtime paramters.
- 05.02.17: - Update to alpine 3.5 and change dvb-apps to only compile needed libs.
- 14.11.16: - Add picons from picons.xyz to /picons folder and add info to README.
- 22.09.16: - Fix broken tv_grab_wg, libs for xmltv and update README.
- 18.09.16: - Update XMLTV to 0.5.68 and update README.
- 10.09.16: - Add layer badges to README.
- 05.09.16: - Initial Release.
linuxserver/ubooquity¶
Ubooquity is a free, lightweight and easy-to-use home server for your comics and ebooks. Use it to access your files from anywhere, with a tablet, an e-reader, a phone or a computer.
Supported Architectures¶
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/ubooquity:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
IMPORTANT Ubooquity has now been upgraded to version 2 and for existing v1.x users we recommend cleaning your appdata and reinstalling, due to changes in the application itself making the two versions essentially incompatible with each other. Also the admin page and library pages are now on separate ports as detailed below.
Access the admin page at http://<your-ip>:2203/ubooquity/admin and set a password.
Then you can access the webui at http://<your-ip>:2202/ubooquity/
This container will automatically scan your files at startup.
MAXMEM¶
The quantity of memory allocated to Ubooquity depends on the hardware your are running it on. If this quantity is too small, you might sometime saturate it with when performing memory intensive operations. That’s when you get java.lang.OutOfMemoryError: Java heap space errors.
You can explicitly set the amount of memory Ubooquity is allowed to use (be careful to set a value lower than the actual physical memory of your hardware). Value is a number of megabytes ( put just a number, without MB )
If no value is set it will default to 512MB.
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)¶
---
+ ubooquity - LinuxServer.io linuxserver/ubooquity¶
Ubooquity is a free, lightweight and easy-to-use home server for your comics and ebooks. Use it to access your files from anywhere, with a tablet, an e-reader, a phone or a computer.
Supported Architectures¶
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/ubooquity:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
IMPORTANT Ubooquity has now been upgraded to version 2 and for existing v1.x users we recommend cleaning your appdata and reinstalling, due to changes in the application itself making the two versions essentially incompatible with each other. Also the admin page and library pages are now on separate ports as detailed below.
Access the admin page at http://<your-ip>:2203/ubooquity/admin and set a password.
Then you can access the webui at http://<your-ip>:2202/ubooquity/
This container will automatically scan your files at startup.
MAXMEM¶
The quantity of memory allocated to Ubooquity depends on the hardware your are running it on. If this quantity is too small, you might sometime saturate it with when performing memory intensive operations. That’s when you get java.lang.OutOfMemoryError: Java heap space errors.
You can explicitly set the amount of memory Ubooquity is allowed to use (be careful to set a value lower than the actual physical memory of your hardware). Value is a number of megabytes ( put just a number, without MB )
If no value is set it will default to 512MB.
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)¶
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 2202The library port. 2203The admin port.
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. MAXMEM=To set the maximum memory. ( ex: set '1024' for 1GB )
Volume Mappings (-v)¶
Volume Function /configConfig files and database for ubooquity. /booksLocation of books. /comicsLocation of comics. /filesLocation of raw files.
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:
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:
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 ubooquity /bin/bash- To monitor the logs of the container in realtime:
docker logs -f ubooquity- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' ubooquity- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/ubooquity:latest
Versions¶
- 12.07.23: - Rebase to Alpine 3.18.
- 04.07.23: - Deprecate armhf. As announced here
- 05.03.23: - Rebase to Alpine 3.17.
- 10.10.22: - Rebasing to alpine 3.16, migrate to s6v3.
- 23.01.21: - Rebasing to alpine 3.13.
- 01.06.20: - Rebasing to alpine 3.12.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebasing to alpine 3.9.
- 28.01.19: - Add pipeline logic and multi arch.
- 15.10.18: - Upgrade to Ubooquity 2.1.2.
- 23.08.18: - Rebase to alpine 3.8.
- 09.12.17: - Rebase to alpine 3.7.
- 07.10.17: - Upgrade to Ubooquity 2.1.1.
- 16.07.17: - Upgrade to Ubooquity 2.1.0, see setting up application section for important info for existing v1.x users.
- 26.05.17: - Rebase to alpine 3.6.
- 08.04.17: - Switch to java from 3.5 repo, fixes login crashes.
- 06.02.17: - Rebase to alpine 3.5.
- 06.12.16: - Initial Release.
\ No newline at end of file
+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 ubooquity /bin/bash- To monitor the logs of the container in realtime:
docker logs -f ubooquity- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' ubooquity- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/ubooquity:latest
Versions¶
- 12.07.23: - Rebase to Alpine 3.18.
- 04.07.23: - Deprecate armhf. As announced here
- 05.03.23: - Rebase to Alpine 3.17.
- 10.10.22: - Rebasing to alpine 3.16, migrate to s6v3.
- 23.01.21: - Rebasing to alpine 3.13.
- 01.06.20: - Rebasing to alpine 3.12.
- 19.12.19: - Rebasing to alpine 3.11.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebasing to alpine 3.9.
- 28.01.19: - Add pipeline logic and multi arch.
- 15.10.18: - Upgrade to Ubooquity 2.1.2.
- 23.08.18: - Rebase to alpine 3.8.
- 09.12.17: - Rebase to alpine 3.7.
- 07.10.17: - Upgrade to Ubooquity 2.1.1.
- 16.07.17: - Upgrade to Ubooquity 2.1.0, see setting up application section for important info for existing v1.x users.
- 26.05.17: - Rebase to alpine 3.6.
- 08.04.17: - Switch to java from 3.5 repo, fixes login crashes.
- 06.02.17: - Rebase to alpine 3.5.
- 06.12.16: - Initial Release.
linuxserver/unifi-controller¶
The Unifi-controller software is a powerful, enterprise wireless software engine ideal for high-density client deployments requiring low latency and high uptime performance.
Supported Architectures¶
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/unifi-controller:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
| Tag | Available | Description |
|---|---|---|
| latest | ✅ | Stable Unifi Controller releases. |
| mongoless | ✅ | Stable Unifi Controller releases without mongodb included. |
| ## Application Setup |
The webui is at https://ip:8443, setup with the first run wizard.
Please note, Unifi change the location of this option every few releases so if it's not where it says, search for "Inform" or "Inform Host" in the settings.¶
For Unifi to adopt other devices, e.g. an Access Point, it is required to change the inform IP address. Because Unifi runs inside Docker by default it uses an IP address not accessible by other devices. To change this go to Settings > System > Advanced and set the Inform Host to a hostname or IP address accessible by your devices. Additionally the checkbox "Override" has to be checked, so that devices can connect to the controller during adoption (devices use the inform-endpoint during adoption).
In order to manually adopt a device take these steps:
ssh ubnt@$AP-IP
+ unifi-controller - LinuxServer.io linuxserver/unifi-controller¶
The Unifi-controller software is a powerful, enterprise wireless software engine ideal for high-density client deployments requiring low latency and high uptime performance.
Supported Architectures¶
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/unifi-controller:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
Tag Available Description latest ✅ Stable Unifi Controller releases. mongoless ✅ Stable Unifi Controller releases without mongodb included. ## Application Setup
The webui is at https://ip:8443, setup with the first run wizard.
Please note, Unifi change the location of this option every few releases so if it's not where it says, search for "Inform" or "Inform Host" in the settings.¶
For Unifi to adopt other devices, e.g. an Access Point, it is required to change the inform IP address. Because Unifi runs inside Docker by default it uses an IP address not accessible by other devices. To change this go to Settings > System > Advanced and set the Inform Host to a hostname or IP address accessible by your devices. Additionally the checkbox "Override" has to be checked, so that devices can connect to the controller during adoption (devices use the inform-endpoint during adoption).
In order to manually adopt a device take these steps:
The default device password is ubnt. $address is the IP address of the host you are running this container on and $AP-IP is the Access Point IP address.
When using a Security Gateway (router) it could be that network connected devices are unable to obtain an ip address. This can be fixed by setting "DHCP Gateway IP", under Settings > Networks > network_name, to a correct (and accessable) ip address.
Strict reverse proxies¶
This image uses a self-signed certificate by default. This naturally means the scheme is https. If you are using a reverse proxy which validates certificates, you need to disable this check for the container.
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)¶
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 8443Unifi web admin port 3478/udpUnifi STUN port 10001/udpRequired for AP discovery 8080Required for device communication 1900/udpRequired for Make controller discoverable on L2 network option 8843Unifi guest portal HTTPS redirect port 8880Unifi guest portal HTTP redirect port 6789For mobile throughput test 5514/udpRemote syslog port
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. MEM_LIMIT=1024Optionally change the Java memory limit (in Megabytes). Set to default to reset to default MEM_STARTUP=1024Optionally change the Java initial/minimum memory (in Megabytes). Set to default to reset to default
Volume Mappings (-v)¶
Volume Function /configAll Unifi data stored here
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:
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:
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 unifi-controller /bin/bash- To monitor the logs of the container in realtime:
docker logs -f unifi-controller- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' unifi-controller- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/unifi-controller:latest
Versions¶
- 02.05.23: - Cleanup
apt-get install during build to reduce image size. - 18.03.23: - Add mongoless branch.
- 10.03.23: - Test writing to /run/unifi and symlink to /config/run if it fails.
- 20.02.23: - Migrate to s6v3, install deb package on build, fix permissions.
- 23.01.23: - Exclude
run from /config volume. - 30.11.22: - Bump JRE to 11.
- 01.06.22: - Deprecate armhf.
- 23.12.21: - Move min/max memory config from run to system.properties.
- 22.12.21: - Move deb package install to first init to avoid overlayfs performance issues.
- 13.12.21: - Rebase 64 bit containers to Focal.
- 11.12.21: - Add java opts to mitigate CVE-2021-44228.
- 11.06.21: - Allow for changing Java initial mem via new optional environment variable.
- 12.01.21: - Deprecate the
LTS tag as Unifi no longer releases LTS stable builds. Existing users can switch to the latest tag. Direct upgrade from 5.6.42 (LTS) to 6.0.42 (latest) tested successfully. - 17.07.20: - Rebase 64 bit containers to Bionic and Mongo 3.6.
- 16.06.20: - Add logrotate.
- 02.06.20: - Updated port list & descriptions. Moved some ports to optional.
- 14.11.19: - Changed url for deb package to match new Ubiquity domain.
- 29.07.19: - Allow for changing Java mem limit via new optional environment variable.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 10.02.19: - Initial release of new unifi-controller image with new tags and pipeline logic
\ No newline at end of file
+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 unifi-controller /bin/bash- To monitor the logs of the container in realtime:
docker logs -f unifi-controller- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' unifi-controller- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/unifi-controller:latest
Versions¶
- 02.05.23: - Cleanup
apt-get installduring build to reduce image size. - 18.03.23: - Add mongoless branch.
- 10.03.23: - Test writing to /run/unifi and symlink to /config/run if it fails.
- 20.02.23: - Migrate to s6v3, install deb package on build, fix permissions.
- 23.01.23: - Exclude
runfrom/configvolume. - 30.11.22: - Bump JRE to 11.
- 01.06.22: - Deprecate armhf.
- 23.12.21: - Move min/max memory config from run to system.properties.
- 22.12.21: - Move deb package install to first init to avoid overlayfs performance issues.
- 13.12.21: - Rebase 64 bit containers to Focal.
- 11.12.21: - Add java opts to mitigate CVE-2021-44228.
- 11.06.21: - Allow for changing Java initial mem via new optional environment variable.
- 12.01.21: - Deprecate the
LTStag as Unifi no longer releases LTS stable builds. Existing users can switch to thelatesttag. Direct upgrade from 5.6.42 (LTS) to 6.0.42 (latest) tested successfully. - 17.07.20: - Rebase 64 bit containers to Bionic and Mongo 3.6.
- 16.06.20: - Add logrotate.
- 02.06.20: - Updated port list & descriptions. Moved some ports to optional.
- 14.11.19: - Changed url for deb package to match new Ubiquity domain.
- 29.07.19: - Allow for changing Java mem limit via new optional environment variable.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 10.02.19: - Initial release of new unifi-controller image with new tags and pipeline logic
The LinuxServer.io team brings you another container release featuring:
- regular and timely application updates
- easy user mappings (PGID, PUID)
- custom base image with s6 overlay
- weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
- regular security updates
Find us at:
- Blog - all the things you can do with our containers including How-To guides, opinions and much more!
- Discord - realtime support / chat with the community and the team.
- Discourse - post on our community forum.
- Fleet - an online web interface which displays all of our maintained images.
- GitHub - view the source for all of our repositories.
- Open Collective - please consider helping us by either donating or contributing to our budget
linuxserver/unrar¶
Usage¶
This image only contains the compiled unrar binaries for Alpine and Ubuntu, and is meant to be ingested by other images during build time. It is not for public consumption.
The currently included binaries are as follows: * /usr/bin/unrar-alpine * /usr/bin/unrar-ubuntu
Versions¶
- 11.08.23: - Initial release.
The LinuxServer.io team brings you another container release featuring:
- regular and timely application updates
- easy user mappings (PGID, PUID)
- custom base image with s6 overlay
- weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
- regular security updates
Find us at:
- Blog - all the things you can do with our containers including How-To guides, opinions and much more!
- Discord - realtime support / chat with the community and the team.
- Discourse - post on our community forum.
- Fleet - an online web interface which displays all of our maintained images.
- GitHub - view the source for all of our repositories.
- Open Collective - please consider helping us by either donating or contributing to our budget
linuxserver/unrar¶
Usage¶
This image only contains the compiled unrar binaries for Alpine and Ubuntu, and is meant to be ingested by other images during build time. It is not for public consumption.
The currently included binaries are as follows: * /usr/bin/unrar-alpine * /usr/bin/unrar-ubuntu
Versions¶
- 11.08.23: - Initial release.
linuxserver/vscodium¶
VSCodium is a community-driven, freely-licensed binary distribution of Microsoft’s editor VS Code.
Supported Architectures¶
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/vscodium:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
The application can be accessed at:
- http://yourhost:3000/
- https://yourhost:3001/
Options in all KasmVNC based GUI containers¶
This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.
Optional environment variables¶
| Variable | Description |
|---|---|
| CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default 3000. |
| CUSTOM_HTTPS_PORT | Internal port the container listens on for https if it needs to be swapped from the default 3001. |
| CUSTOM_USER | HTTP Basic auth username, abc is default. |
| PASSWORD | HTTP Basic auth password, abc is default. If unset there will be no auth |
| SUBFOLDER | Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/ |
| TITLE | The page title displayed on the web browser, default "KasmVNC Client". |
| FM_HOME | This is the home directory (landing) for the file manager, default "/config". |
| START_DOCKER | If set to false a container with privilege will not automatically start the DinD Docker setup. |
| DRINODE | If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE /dev/dri/renderD128 |
Optional run configurations¶
| Variable | Description |
|---|---|
--privileged | Will start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE -v /home/user/docker-data:/var/lib/docker. |
-v /var/run/docker.sock:/var/run/docker.sock | Mount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. |
--device /dev/dri:/dev/dri | Mount a GPU into the container, this can be used in conjunction with the DRINODE environment variable to leverage a host video card for GPU accelerated appplications. Only Open Source drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau) |
Lossless mode¶
This container is capable of delivering a true lossless image at a high framerate to your web browser by changing the Stream Quality preset to "Lossless", more information here. In order to use this mode from a non localhost endpoint the HTTPS port on 3001 needs to be used. If using a reverse proxy to port 3000 specific headers will need to be set as outlined here.
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)¶
---
+ vscodium - LinuxServer.io linuxserver/vscodium¶
VSCodium is a community-driven, freely-licensed binary distribution of Microsoft’s editor VS Code.
Supported Architectures¶
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/vscodium:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
The application can be accessed at:
- http://yourhost:3000/
- https://yourhost:3001/
Options in all KasmVNC based GUI containers¶
This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.
Optional environment variables¶
Variable Description CUSTOM_PORT Internal port the container listens on for http if it needs to be swapped from the default 3000. CUSTOM_HTTPS_PORT Internal port the container listens on for https if it needs to be swapped from the default 3001. CUSTOM_USER HTTP Basic auth username, abc is default. PASSWORD HTTP Basic auth password, abc is default. If unset there will be no auth SUBFOLDER Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/ TITLE The page title displayed on the web browser, default "KasmVNC Client". FM_HOME This is the home directory (landing) for the file manager, default "/config". START_DOCKER If set to false a container with privilege will not automatically start the DinD Docker setup. DRINODE If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE /dev/dri/renderD128
Optional run configurations¶
Variable Description --privilegedWill start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE -v /home/user/docker-data:/var/lib/docker. -v /var/run/docker.sock:/var/run/docker.sockMount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. --device /dev/dri:/dev/driMount a GPU into the container, this can be used in conjunction with the DRINODE environment variable to leverage a host video card for GPU accelerated appplications. Only Open Source drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau)
Lossless mode¶
This container is capable of delivering a true lossless image at a high framerate to your web browser by changing the Stream Quality preset to "Lossless", more information here. In order to use this mode from a non localhost endpoint the HTTPS port on 3001 needs to be used. If using a reverse proxy to port 3000 specific headers will need to be set as outlined here.
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)¶
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 3000VSCodium desktop gui. 3001HTTPS VSCodium desktop gui.
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configUsers home directory in the container, stores local files and settings
Miscellaneous Options¶
Parameter Function --shm-size=This is needed for electron applications to function properly. --security-opt seccomp=unconfinedFor Docker Engine only, many modern gui apps need this to function on older hosts as syscalls are unknown to Docker. VSCodium runs in no-sandbox mode without it.
Portainer notice¶
{% hint style="warning" %} This image utilises cap_add or sysctl to work properly. This is not implemented properly in some versions of Portainer, thus this image may not work if deployed through Portainer.
Environment variables from files (Docker secrets)¶
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
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:
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 vscodium /bin/bash- To monitor the logs of the container in realtime:
docker logs -f vscodium- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' vscodium- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/vscodium:latest
Versions¶
- 02.04.23: - Initial release.
\ No newline at end of file
+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 vscodium /bin/bash- To monitor the logs of the container in realtime:
docker logs -f vscodium- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' vscodium- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/vscodium:latest
Versions¶
- 02.04.23: - Initial release.
linuxserver/webcord¶
WebCord can be summarized as a pack of security and privacy hardenings, Discord features reimplementations, Electron / Chromium / Discord bugs workarounds, stylesheets, internal pages and wrapped https://discord.com page, designed to conform with ToS as much as it is possible (or hide the changes that might violate it from Discord's eyes).
Supported Architectures¶
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/webcord:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
The application can be accessed at:
- http://yourhost:3000/
- https://yourhost:3001/
Options in all KasmVNC based GUI containers¶
This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.
Optional environment variables¶
| Variable | Description |
|---|---|
| CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default 3000. |
| CUSTOM_HTTPS_PORT | Internal port the container listens on for https if it needs to be swapped from the default 3001. |
| CUSTOM_USER | HTTP Basic auth username, abc is default. |
| PASSWORD | HTTP Basic auth password, abc is default. If unset there will be no auth |
| SUBFOLDER | Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/ |
| TITLE | The page title displayed on the web browser, default "KasmVNC Client". |
| FM_HOME | This is the home directory (landing) for the file manager, default "/config". |
| START_DOCKER | If set to false a container with privilege will not automatically start the DinD Docker setup. |
| DRINODE | If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE /dev/dri/renderD128 |
Optional run configurations¶
| Variable | Description |
|---|---|
--privileged | Will start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE -v /home/user/docker-data:/var/lib/docker. |
-v /var/run/docker.sock:/var/run/docker.sock | Mount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. |
--device /dev/dri:/dev/dri | Mount a GPU into the container, this can be used in conjunction with the DRINODE environment variable to leverage a host video card for GPU accelerated appplications. Only Open Source drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau) |
Lossless mode¶
This container is capable of delivering a true lossless image at a high framerate to your web browser by changing the Stream Quality preset to "Lossless", more information here. In order to use this mode from a non localhost endpoint the HTTPS port on 3001 needs to be used. If using a reverse proxy to port 3000 specific headers will need to be set as outlined here.
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)¶
---
+ webcord - LinuxServer.io linuxserver/webcord¶
WebCord can be summarized as a pack of security and privacy hardenings, Discord features reimplementations, Electron / Chromium / Discord bugs workarounds, stylesheets, internal pages and wrapped https://discord.com page, designed to conform with ToS as much as it is possible (or hide the changes that might violate it from Discord's eyes).
Supported Architectures¶
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/webcord:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
The application can be accessed at:
- http://yourhost:3000/
- https://yourhost:3001/
Options in all KasmVNC based GUI containers¶
This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.
Optional environment variables¶
Variable Description CUSTOM_PORT Internal port the container listens on for http if it needs to be swapped from the default 3000. CUSTOM_HTTPS_PORT Internal port the container listens on for https if it needs to be swapped from the default 3001. CUSTOM_USER HTTP Basic auth username, abc is default. PASSWORD HTTP Basic auth password, abc is default. If unset there will be no auth SUBFOLDER Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/ TITLE The page title displayed on the web browser, default "KasmVNC Client". FM_HOME This is the home directory (landing) for the file manager, default "/config". START_DOCKER If set to false a container with privilege will not automatically start the DinD Docker setup. DRINODE If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE /dev/dri/renderD128
Optional run configurations¶
Variable Description --privilegedWill start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE -v /home/user/docker-data:/var/lib/docker. -v /var/run/docker.sock:/var/run/docker.sockMount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. --device /dev/dri:/dev/driMount a GPU into the container, this can be used in conjunction with the DRINODE environment variable to leverage a host video card for GPU accelerated appplications. Only Open Source drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau)
Lossless mode¶
This container is capable of delivering a true lossless image at a high framerate to your web browser by changing the Stream Quality preset to "Lossless", more information here. In order to use this mode from a non localhost endpoint the HTTPS port on 3001 needs to be used. If using a reverse proxy to port 3000 specific headers will need to be set as outlined here.
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)¶
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 3000WebCord desktop gui. 3001WebCord desktop gui HTTPS.
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configUsers home directory in the container, stores program settings.
Miscellaneous Options¶
Parameter Function --shm-size=This is needed for electron applications to function properly. --security-opt seccomp=unconfinedFor Docker Engine only, many modern gui apps need this to function on older hosts as syscalls are unknown to Docker.
Environment variables from files (Docker secrets)¶
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
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:
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 webcord /bin/bash- To monitor the logs of the container in realtime:
docker logs -f webcord- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' webcord- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/webcord:latest
Versions¶
- 18.05.23: - Add fonts-noto-cjk for shrug support.
- 12.05.23: - Add fonts-noto-color-emoji for better emoji support.
- 09.05.23: - Bundle Chromium to provide browser for opening links, etc.
- 21.04.23: - Initial release.
\ No newline at end of file
+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 webcord /bin/bash- To monitor the logs of the container in realtime:
docker logs -f webcord- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' webcord- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/webcord:latest
Versions¶
- 18.05.23: - Add fonts-noto-cjk for shrug support.
- 12.05.23: - Add fonts-noto-color-emoji for better emoji support.
- 09.05.23: - Bundle Chromium to provide browser for opening links, etc.
- 21.04.23: - Initial release.
linuxserver/webgrabplus¶
Webgrabplus is a multi-site incremental xmltv epg grabber. It collects tv-program guide data from selected tvguide sites for your favourite channels.
Supported Architectures¶
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/webgrabplus:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
To configure WebGrab+Plus follow the documentation
Please note that depending on your host this container may not work with the no-new-privileges=true security-opt.
Note that there are some things in the guide that does not apply to this container. Below you can find the changes.
The configuration files are found where your config volume is mounted. Do not change the filename tag in the configuration file!
The /data volume mapping is where WebGrab+Plus outputs the xml file. To use the xml file in another program, you have to point it to the host path you mapped the /data volume to.
To adjust the scheduled cron job for grabbing, edit the wg3-cron file found in the /config folder. After you have edited the the wg3-cron file, restart the container to apply the new schedule. Do not adjust the command!
Note that due to something in version 3, we had to change the commands for scheduling the grab. If you have a version where there is a wg-cron file in your /config mount, delete it and use wg3-cron instead.
Below is the syntax of the cron file.
┌───────────── minute (0 - 59)
+ webgrabplus - LinuxServer.io linuxserver/webgrabplus¶
Webgrabplus is a multi-site incremental xmltv epg grabber. It collects tv-program guide data from selected tvguide sites for your favourite channels.
Supported Architectures¶
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/webgrabplus:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
To configure WebGrab+Plus follow the documentation
Please note that depending on your host this container may not work with the no-new-privileges=true security-opt.
Note that there are some things in the guide that does not apply to this container. Below you can find the changes.
The configuration files are found where your config volume is mounted. Do not change the filename tag in the configuration file!
The /data volume mapping is where WebGrab+Plus outputs the xml file. To use the xml file in another program, you have to point it to the host path you mapped the /data volume to.
To adjust the scheduled cron job for grabbing, edit the wg3-cron file found in the /config folder. After you have edited the the wg3-cron file, restart the container to apply the new schedule. Do not adjust the command!
Note that due to something in version 3, we had to change the commands for scheduling the grab. If you have a version where there is a wg-cron file in your /config mount, delete it and use wg3-cron instead.
Below is the syntax of the cron file.
┌───────────── minute (0 - 59)
│ ┌───────────── hour (0 - 23)
│ │ ┌───────────── day of month (1 - 31)
│ │ │ ┌───────────── month (1 - 12)
@@ -37,4 +37,4 @@
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
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configWhere webgrabplus should store it's config files. /dataWhere webgrabplus should store it's data files.
Miscellaneous Options¶
Parameter Function --hostname=Set the hostname for the container for the license check. --mac-address=Set the mac_address for the container for the license check.
Environment variables from files (Docker secrets)¶
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
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:
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 webgrabplus /bin/bash- To monitor the logs of the container in realtime:
docker logs -f webgrabplus- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' webgrabplus- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/webgrabplus:latest
Versions¶
- 18.08.23: - Rebase to Alpine 3.18.
- 16.08.23: - Update dotnet framework to 7.x.
- 06.07.23: - Deprecate armhf. As announced here
- 13.03.23: - Rebase to Alpine 3.17.
- 23.03.22: - Rebase to Alpine 3.16 and s6v3. Update to dotnet 6.
- 29.04.22: - Add
hostname and mac_address arguments that are needed for the license check to compose and cli samples. - 23.03.22: - Rebase to Alpine 3.15.
- 23.03.22: - Update to use dotnet instead of mono.
- 06.01.22: - Rebase to Ubuntu focal. Enable auto builds on version updates (beta and stable).
- 17.12.21: - Update to version 3.2.2 beta.
- 05.08.21: - Update to version 3.2.1 beta.
- 05.06.21: - Added mono-devel dependency.
- 04.06.21: - Update to version 3.1.8 beta.
- 22.03.21: - Update to version 3.1.7 beta.
- 07.03.21: - Update to version 3.1.6 beta.
- 29.01.21: - Update external version number to show as 3.1.5.
- 24.01.21: - Update to version 3.1.5 beta.
- 22.12.20: - Update to version 3.1.4 beta.
- 12.10.20: - Fix version number in jenkinsfile.
- 12.10.20: - Update to version 3.1.1 beta.
- 22.06.20: - Add mono webrequest library.
- 18.06.20: - Update to v3.1.0.
- 29.03.20: - Update to v3.0.0. Changed to use wg3-cron file.
- 28.05.19: - Update to v2.1.0 and beta v2.1.9, rebase to bionic.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 21.03.19: - Update to beta 2.1.7.
- 19.02.19: - Add pipeline logic and multi arch.
- 18.01.18: - Initial Release.
\ No newline at end of file
+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 webgrabplus /bin/bash- To monitor the logs of the container in realtime:
docker logs -f webgrabplus- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' webgrabplus- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/webgrabplus:latest
Versions¶
- 18.08.23: - Rebase to Alpine 3.18.
- 16.08.23: - Update dotnet framework to 7.x.
- 06.07.23: - Deprecate armhf. As announced here
- 13.03.23: - Rebase to Alpine 3.17.
- 23.03.22: - Rebase to Alpine 3.16 and s6v3. Update to dotnet 6.
- 29.04.22: - Add
hostnameandmac_addressarguments that are needed for the license check to compose and cli samples. - 23.03.22: - Rebase to Alpine 3.15.
- 23.03.22: - Update to use dotnet instead of mono.
- 06.01.22: - Rebase to Ubuntu focal. Enable auto builds on version updates (beta and stable).
- 17.12.21: - Update to version 3.2.2 beta.
- 05.08.21: - Update to version 3.2.1 beta.
- 05.06.21: - Added mono-devel dependency.
- 04.06.21: - Update to version 3.1.8 beta.
- 22.03.21: - Update to version 3.1.7 beta.
- 07.03.21: - Update to version 3.1.6 beta.
- 29.01.21: - Update external version number to show as 3.1.5.
- 24.01.21: - Update to version 3.1.5 beta.
- 22.12.20: - Update to version 3.1.4 beta.
- 12.10.20: - Fix version number in jenkinsfile.
- 12.10.20: - Update to version 3.1.1 beta.
- 22.06.20: - Add mono webrequest library.
- 18.06.20: - Update to v3.1.0.
- 29.03.20: - Update to v3.0.0. Changed to use wg3-cron file.
- 28.05.19: - Update to v2.1.0 and beta v2.1.9, rebase to bionic.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 21.03.19: - Update to beta 2.1.7.
- 19.02.19: - Add pipeline logic and multi arch.
- 18.01.18: - Initial Release.
linuxserver/webtop¶
Webtop - Alpine, Ubuntu, Fedora, and Arch based containers containing full desktop environments in officially supported flavors accessible via any modern web browser.
Supported Architectures¶
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/webtop:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
| Tag | Available | Description |
|---|---|---|
| latest | ✅ | XFCE Alpine |
| ubuntu-xfce | ✅ | XFCE Ubuntu |
| fedora-xfce | ✅ | XFCE Fedora |
| arch-xfce | ✅ | XFCE Arch |
| debian-xfce | ✅ | XFCE Debian |
| alpine-kde | ✅ | KDE Alpine |
| ubuntu-kde | ✅ | KDE Ubuntu |
| fedora-kde | ✅ | KDE Fedora |
| arch-kde | ✅ | KDE Arch |
| debian-kde | ✅ | KDE Debian |
| alpine-mate | ✅ | MATE Alpine |
| ubuntu-mate | ✅ | MATE Ubuntu |
| fedora-mate | ✅ | MATE Fedora |
| arch-mate | ✅ | MATE Arch |
| debian-mate | ✅ | MATE Debian |
| alpine-i3 | ✅ | i3 Alpine |
| ubuntu-i3 | ✅ | i3 Ubuntu |
| fedora-i3 | ✅ | i3 Fedora |
| arch-i3 | ✅ | i3 Arch |
| debian-i3 | ✅ | i3 Debian |
| alpine-openbox | ✅ | Openbox Alpine |
| ubuntu-openbox | ✅ | Openbox Ubuntu |
| fedora-openbox | ✅ | Openbox Fedora |
| arch-openbox | ✅ | Openbox Arch |
| debian-openbox | ✅ | Openbox Debian |
| alpine-icewm | ✅ | IceWM Alpine |
| ubuntu-icewm | ✅ | IceWM Ubuntu |
| fedora-icewm | ✅ | IceWM Fedora |
| arch-icewm | ✅ | IceWM Arch |
| debian-icewm | ✅ | IceWM Debian |
| ## Application Setup |
The Webtop can be accessed at:
- http://yourhost:3000/
- https://yourhost:3001/
Modern GUI desktop apps (including some flavors terminals) have issues with the latest Docker and syscall compatibility, you can use Docker with the --security-opt seccomp=unconfined setting to allow these syscalls
Unlike our other containers these Desktops are not designed to be upgraded by Docker, you will keep your home directory but anything you installed system level will be lost if you upgrade an existing container. To keep packages up to date instead use Ubuntu/Debians's own apt, Alpine's apk, Fedora's dnf, or Arch's pacman program
Options in all KasmVNC based GUI containers¶
This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.
Optional environment variables¶
| Variable | Description |
|---|---|
| CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default 3000. |
| CUSTOM_HTTPS_PORT | Internal port the container listens on for https if it needs to be swapped from the default 3001. |
| CUSTOM_USER | HTTP Basic auth username, abc is default. |
| PASSWORD | HTTP Basic auth password, abc is default. If unset there will be no auth |
| SUBFOLDER | Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/ |
| TITLE | The page title displayed on the web browser, default "KasmVNC Client". |
| FM_HOME | This is the home directory (landing) for the file manager, default "/config". |
| START_DOCKER | If set to false a container with privilege will not automatically start the DinD Docker setup. |
| DRINODE | If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE /dev/dri/renderD128 |
Optional run configurations¶
| Variable | Description |
|---|---|
--privileged | Will start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE -v /home/user/docker-data:/var/lib/docker. |
-v /var/run/docker.sock:/var/run/docker.sock | Mount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. |
--device /dev/dri:/dev/dri | Mount a GPU into the container, this can be used in conjunction with the DRINODE environment variable to leverage a host video card for GPU accelerated applications. Only Open Source drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau) |
Language Support - Internationalization¶
The universal internationalization docker mod can be used with any of these variants to provide non english language support. All you need to know is your specific iso-639 code for your your desired language. For example German is de_DE.UTF-8 Chinese zh_CN.UTF-8 a full list is here:
https://github.com/linuxserver/docker-mods/tree/universal-internationalization#other-languages
To enable this pass the environment variables:
-e DOCKER_MODS=linuxserver/mods:universal-internationalization
+ webtop - LinuxServer.io linuxserver/webtop¶
Webtop - Alpine, Ubuntu, Fedora, and Arch based containers containing full desktop environments in officially supported flavors accessible via any modern web browser.
Supported Architectures¶
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/webtop:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
Tag Available Description latest ✅ XFCE Alpine ubuntu-xfce ✅ XFCE Ubuntu fedora-xfce ✅ XFCE Fedora arch-xfce ✅ XFCE Arch debian-xfce ✅ XFCE Debian alpine-kde ✅ KDE Alpine ubuntu-kde ✅ KDE Ubuntu fedora-kde ✅ KDE Fedora arch-kde ✅ KDE Arch debian-kde ✅ KDE Debian alpine-mate ✅ MATE Alpine ubuntu-mate ✅ MATE Ubuntu fedora-mate ✅ MATE Fedora arch-mate ✅ MATE Arch debian-mate ✅ MATE Debian alpine-i3 ✅ i3 Alpine ubuntu-i3 ✅ i3 Ubuntu fedora-i3 ✅ i3 Fedora arch-i3 ✅ i3 Arch debian-i3 ✅ i3 Debian alpine-openbox ✅ Openbox Alpine ubuntu-openbox ✅ Openbox Ubuntu fedora-openbox ✅ Openbox Fedora arch-openbox ✅ Openbox Arch debian-openbox ✅ Openbox Debian alpine-icewm ✅ IceWM Alpine ubuntu-icewm ✅ IceWM Ubuntu fedora-icewm ✅ IceWM Fedora arch-icewm ✅ IceWM Arch debian-icewm ✅ IceWM Debian ## Application Setup
The Webtop can be accessed at:
- http://yourhost:3000/
- https://yourhost:3001/
Modern GUI desktop apps (including some flavors terminals) have issues with the latest Docker and syscall compatibility, you can use Docker with the --security-opt seccomp=unconfined setting to allow these syscalls
Unlike our other containers these Desktops are not designed to be upgraded by Docker, you will keep your home directory but anything you installed system level will be lost if you upgrade an existing container. To keep packages up to date instead use Ubuntu/Debians's own apt, Alpine's apk, Fedora's dnf, or Arch's pacman program
Options in all KasmVNC based GUI containers¶
This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.
Optional environment variables¶
Variable Description CUSTOM_PORT Internal port the container listens on for http if it needs to be swapped from the default 3000. CUSTOM_HTTPS_PORT Internal port the container listens on for https if it needs to be swapped from the default 3001. CUSTOM_USER HTTP Basic auth username, abc is default. PASSWORD HTTP Basic auth password, abc is default. If unset there will be no auth SUBFOLDER Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/ TITLE The page title displayed on the web browser, default "KasmVNC Client". FM_HOME This is the home directory (landing) for the file manager, default "/config". START_DOCKER If set to false a container with privilege will not automatically start the DinD Docker setup. DRINODE If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE /dev/dri/renderD128
Optional run configurations¶
Variable Description --privilegedWill start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE -v /home/user/docker-data:/var/lib/docker. -v /var/run/docker.sock:/var/run/docker.sockMount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. --device /dev/dri:/dev/driMount a GPU into the container, this can be used in conjunction with the DRINODE environment variable to leverage a host video card for GPU accelerated applications. Only Open Source drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau)
Language Support - Internationalization¶
The universal internationalization docker mod can be used with any of these variants to provide non english language support. All you need to know is your specific iso-639 code for your your desired language. For example German is de_DE.UTF-8 Chinese zh_CN.UTF-8 a full list is here:
https://github.com/linuxserver/docker-mods/tree/universal-internationalization#other-languages
To enable this pass the environment variables:
The web interface has the option for "IME Input Mode" in Settings which will allow non english characters to be used from a non en_US keyboard on the client. Once enabled in conjunction with the mod it will perform the same as a local Linux installation set to your locale.
Lossless mode¶
This container is capable of delivering a true lossless image at a high framerate to your web browser by changing the Stream Quality preset to "Lossless", more information here. In order to use this mode from a non localhost endpoint the HTTPS port on 3001 needs to be used. If using a reverse proxy to port 3000 specific headers will need to be set as outlined here.
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)¶
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 3000Web Desktop GUI 3001Web Desktop GUI HTTPS
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. SUBFOLDER=/Specify a subfolder to use with reverse proxies, IE /subfolder/ TITLE=WebtopString which will be used as page/tab title in the web browser.
Volume Mappings (-v)¶
Volume Function /configabc users home directory /var/run/docker.sockDocker Socket on the system, if you want to use Docker in the container
Device Mappings (--device)¶
Parameter Function /dev/driAdd this for GL support (Linux hosts only)
Miscellaneous Options¶
Parameter Function --shm-size=We set this to 1 gig to prevent modern web browsers from crashing --security-opt seccomp=unconfinedFor Docker Engine only, many modern gui apps need this to function on older hosts as syscalls are unknown to Docker.
Environment variables from files (Docker secrets)¶
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
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:
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 webtop /bin/bash- To monitor the logs of the container in realtime:
docker logs -f webtop- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' webtop- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/webtop:latest
Versions¶
- 14.06.23: - Rebase to Debian Bookworm.
- 13.05.23: - Rebase to Alpine 3.18 and Fedora 38.
- 23.03.23: - Rebase all Webtops to KasmVNC base image.
- 21.10.22: - Rebase xfce to Alpine 3.16, migrate to s6v3.
- 12.03.22: - Add documentation for mounting in a GPU.
- 05.02.22: - Rebase KDE Ubuntu to Jammy, add new documentation for updated gclient, stop recommending priv mode.
- 21.09.21: - Add Fedora and Arch images, show seccomp settings in readme.
- 26.09.21: - Rebase to Alpine versions to 3.14.
- 20.04.21: - Initial release.
\ No newline at end of file
+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 webtop /bin/bash- To monitor the logs of the container in realtime:
docker logs -f webtop- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' webtop- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/webtop:latest
Versions¶
- 14.06.23: - Rebase to Debian Bookworm.
- 13.05.23: - Rebase to Alpine 3.18 and Fedora 38.
- 23.03.23: - Rebase all Webtops to KasmVNC base image.
- 21.10.22: - Rebase xfce to Alpine 3.16, migrate to s6v3.
- 12.03.22: - Add documentation for mounting in a GPU.
- 05.02.22: - Rebase KDE Ubuntu to Jammy, add new documentation for updated gclient, stop recommending priv mode.
- 21.09.21: - Add Fedora and Arch images, show seccomp settings in readme.
- 26.09.21: - Rebase to Alpine versions to 3.14.
- 20.04.21: - Initial release.
linuxserver/wikijs¶
Wikijs A modern, lightweight and powerful wiki app built on NodeJS.
Supported Architectures¶
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/wikijs:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
Please note that the database configuration environment variables will apply on first run only, after which you will need to directly edit /config/config.yml to change your settings.
For more information please see the official documentation.
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)¶
---
+ wikijs - LinuxServer.io linuxserver/wikijs¶
Wikijs A modern, lightweight and powerful wiki app built on NodeJS.
Supported Architectures¶
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/wikijs:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
Please note that the database configuration environment variables will apply on first run only, after which you will need to directly edit /config/config.yml to change your settings.
For more information please see the official documentation.
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)¶
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 3000Port for Wiki.js's web interface.
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. DB_TYPE=sqliteSet to sqlite (default) or postgres depending on the database engine you wish to use DB_HOST=DB hostname (postgres only) DB_PORT=DB port (postgres only) DB_NAME=DB name (postgres only) DB_USER=DB username (postgres only) DB_PASS=DB password (postgres only)
Volume Mappings (-v)¶
Volume Function /configWhere Wiki.js config is stored. /dataWhere Wiki.js data is stored.
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:
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:
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 wikijs /bin/bash- To monitor the logs of the container in realtime:
docker logs -f wikijs- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' wikijs- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/wikijs:latest
Versions¶
- 25.08.22: - Rebase to Alpine 3.18.
- 07.07.23: - Deprecate armhf. As announced here
- 21.03.23: - Restore git and openssh packages for git storage support.
- 21.03.23: - Create dummy /etc/os-release to fix System Info page.
- 10.10.22: - Rebasing to alpine 3.16, migrate to s6v3.
- 23.01.21: - Rebasing to alpine 3.13.
- 01.06.20: - Rebasing to alpine 3.12.
- 28.04.20: - Added python dependency for some NPM modules as well as git for storage module
- 14.12.19: - Initial Release.
\ No newline at end of file
+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 wikijs /bin/bash- To monitor the logs of the container in realtime:
docker logs -f wikijs- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' wikijs- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/wikijs:latest
Versions¶
- 25.08.22: - Rebase to Alpine 3.18.
- 07.07.23: - Deprecate armhf. As announced here
- 21.03.23: - Restore git and openssh packages for git storage support.
- 21.03.23: - Create dummy /etc/os-release to fix System Info page.
- 10.10.22: - Rebasing to alpine 3.16, migrate to s6v3.
- 23.01.21: - Rebasing to alpine 3.13.
- 01.06.20: - Rebasing to alpine 3.12.
- 28.04.20: - Added python dependency for some NPM modules as well as git for storage module
- 14.12.19: - Initial Release.
linuxserver/wireguard¶
WireGuard® is an extremely simple yet fast and modern VPN that utilizes state-of-the-art cryptography. It aims to be faster, simpler, leaner, and more useful than IPsec, while avoiding the massive headache. It intends to be considerably more performant than OpenVPN. WireGuard is designed as a general purpose VPN for running on embedded interfaces and super computers alike, fit for many different circumstances. Initially released for the Linux kernel, it is now cross-platform (Windows, macOS, BSD, iOS, Android) and widely deployable. It is currently under heavy development, but already it might be regarded as the most secure, easiest to use, and simplest VPN solution in the industry.
Supported Architectures¶
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/wireguard:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
| Tag | Available | Description |
|---|---|---|
| latest | ✅ | Stable releases based on Alpine without support for compiling Wireguard modules. |
| legacy | ✅ | Stable releases with support for compiling Wireguard modules for older kernels. |
| ## Application Setup |
During container start, it will first check if the wireguard module is already installed and loaded. Kernels newer than 5.6 generally have the wireguard module built-in (along with some older custom kernels). However, the module may not be enabled. Make sure it is enabled prior to starting the container.
This can be run as a server or a client, based on the parameters used.
Note on iptables¶
Some hosts may not load the iptables kernel modules by default. In order for the container to be able to load them, you need to assign the SYS_MODULE capability and add the optional /lib/modules volume mount. Alternatively you can modprobe them from the host before starting the container.
Server Mode¶
If the environment variable PEERS is set to a number or a list of strings separated by comma, the container will run in server mode and the necessary server and peer/client confs will be generated. The peer/client config qr codes will be output in the docker log if LOG_CONFS is set to true. They will also be saved in text and png format under /config/peerX in case PEERS is a variable and an integer or /config/peer_X in case a list of names was provided instead of an integer.
Variables SERVERURL, SERVERPORT, INTERNAL_SUBNET, PEERDNS, INTERFACE, ALLOWEDIPS and PERSISTENTKEEPALIVE_PEERS are optional variables used for server mode. Any changes to these environment variables will trigger regeneration of server and peer confs. Peer/client confs will be recreated with existing private/public keys. Delete the peer folders for the keys to be recreated along with the confs.
To add more peers/clients later on, you increment the PEERS environment variable or add more elements to the list and recreate the container.
To display the QR codes of active peers again, you can use the following command and list the peer numbers as arguments: docker exec -it wireguard /app/show-peer 1 4 5 or docker exec -it wireguard /app/show-peer myPC myPhone myTablet (Keep in mind that the QR codes are also stored as PNGs in the config folder).
The templates used for server and peer confs are saved under /config/templates. Advanced users can modify these templates and force conf generation by deleting /config/wg0.conf and restarting the container.
Client Mode¶
Do not set the PEERS environment variable. Drop your client conf into the config folder as /config/wg0.conf and start the container.
If you get IPv6 related errors in the log and connection cannot be established, edit the AllowedIPs line in your peer/client wg0.conf to include only 0.0.0.0/0 and not ::/0; and restart the container.
Road warriors, roaming and returning home¶
If you plan to use Wireguard both remotely and locally, say on your mobile phone, you will need to consider routing. Most firewalls will not route ports forwarded on your WAN interface correctly to the LAN out of the box. This means that when you return home, even though you can see the Wireguard server, the return packets will probably get lost.
This is not a Wireguard specific issue and the two generally accepted solutions are NAT reflection (setting your edge router/firewall up in such a way as it translates internal packets correctly) or split horizon DNS (setting your internal DNS to return the private rather than public IP when connecting locally).
Both of these approaches have positives and negatives however their setup is out of scope for this document as everyone's network layout and equipment will be different.
Maintaining local access to attached services¶
** Note: This is not a supported configuration by Linuxserver.io - use at your own risk.
When routing via Wireguard from another container using the service option in docker, you might lose access to the containers webUI locally. To avoid this, exclude the docker subnet from being routed via Wireguard by modifying your wg0.conf like so (modifying the subnets as you require):
[Interface]
+ wireguard - LinuxServer.io linuxserver/wireguard¶
WireGuard® is an extremely simple yet fast and modern VPN that utilizes state-of-the-art cryptography. It aims to be faster, simpler, leaner, and more useful than IPsec, while avoiding the massive headache. It intends to be considerably more performant than OpenVPN. WireGuard is designed as a general purpose VPN for running on embedded interfaces and super computers alike, fit for many different circumstances. Initially released for the Linux kernel, it is now cross-platform (Windows, macOS, BSD, iOS, Android) and widely deployable. It is currently under heavy development, but already it might be regarded as the most secure, easiest to use, and simplest VPN solution in the industry.
Supported Architectures¶
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/wireguard:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Version Tags¶
This image provides various versions that are available via tags. Please read the descriptions carefully and exercise caution when using unstable or development tags.
Tag Available Description latest ✅ Stable releases based on Alpine without support for compiling Wireguard modules. legacy ✅ Stable releases with support for compiling Wireguard modules for older kernels. ## Application Setup
During container start, it will first check if the wireguard module is already installed and loaded. Kernels newer than 5.6 generally have the wireguard module built-in (along with some older custom kernels). However, the module may not be enabled. Make sure it is enabled prior to starting the container.
This can be run as a server or a client, based on the parameters used.
Note on iptables¶
Some hosts may not load the iptables kernel modules by default. In order for the container to be able to load them, you need to assign the SYS_MODULE capability and add the optional /lib/modules volume mount. Alternatively you can modprobe them from the host before starting the container.
Server Mode¶
If the environment variable PEERS is set to a number or a list of strings separated by comma, the container will run in server mode and the necessary server and peer/client confs will be generated. The peer/client config qr codes will be output in the docker log if LOG_CONFS is set to true. They will also be saved in text and png format under /config/peerX in case PEERS is a variable and an integer or /config/peer_X in case a list of names was provided instead of an integer.
Variables SERVERURL, SERVERPORT, INTERNAL_SUBNET, PEERDNS, INTERFACE, ALLOWEDIPS and PERSISTENTKEEPALIVE_PEERS are optional variables used for server mode. Any changes to these environment variables will trigger regeneration of server and peer confs. Peer/client confs will be recreated with existing private/public keys. Delete the peer folders for the keys to be recreated along with the confs.
To add more peers/clients later on, you increment the PEERS environment variable or add more elements to the list and recreate the container.
To display the QR codes of active peers again, you can use the following command and list the peer numbers as arguments: docker exec -it wireguard /app/show-peer 1 4 5 or docker exec -it wireguard /app/show-peer myPC myPhone myTablet (Keep in mind that the QR codes are also stored as PNGs in the config folder).
The templates used for server and peer confs are saved under /config/templates. Advanced users can modify these templates and force conf generation by deleting /config/wg0.conf and restarting the container.
Client Mode¶
Do not set the PEERS environment variable. Drop your client conf into the config folder as /config/wg0.conf and start the container.
If you get IPv6 related errors in the log and connection cannot be established, edit the AllowedIPs line in your peer/client wg0.conf to include only 0.0.0.0/0 and not ::/0; and restart the container.
Road warriors, roaming and returning home¶
If you plan to use Wireguard both remotely and locally, say on your mobile phone, you will need to consider routing. Most firewalls will not route ports forwarded on your WAN interface correctly to the LAN out of the box. This means that when you return home, even though you can see the Wireguard server, the return packets will probably get lost.
This is not a Wireguard specific issue and the two generally accepted solutions are NAT reflection (setting your edge router/firewall up in such a way as it translates internal packets correctly) or split horizon DNS (setting your internal DNS to return the private rather than public IP when connecting locally).
Both of these approaches have positives and negatives however their setup is out of scope for this document as everyone's network layout and equipment will be different.
Maintaining local access to attached services¶
** Note: This is not a supported configuration by Linuxserver.io - use at your own risk.
When routing via Wireguard from another container using the service option in docker, you might lose access to the containers webUI locally. To avoid this, exclude the docker subnet from being routed via Wireguard by modifying your wg0.conf like so (modifying the subnets as you require):
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 51820/udpwireguard port
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. SERVERURL=wireguard.domain.comExternal IP or domain name for docker host. Used in server mode. If set to auto, the container will try to determine and set the external IP automatically SERVERPORT=51820External port for docker host. Used in server mode. PEERS=1Number of peers to create confs for. Required for server mode. Can also be a list of names: myPC,myPhone,myTablet (alphanumeric only) PEERDNS=autoDNS server set in peer/client configs (can be set as 8.8.8.8). Used in server mode. Defaults to auto, which uses wireguard docker host's DNS via included CoreDNS forward. INTERNAL_SUBNET=10.13.13.0Internal subnet for the wireguard and server and peers (only change if it clashes). Used in server mode. ALLOWEDIPS=0.0.0.0/0The IPs/Ranges that the peers will be able to reach using the VPN connection. If not specified the default value is: '0.0.0.0/0, ::0/0' This will cause ALL traffic to route through the VPN, if you want split tunneling, set this to only the IPs you would like to use the tunnel AND the ip of the server's WG ip, such as 10.13.13.1. PERSISTENTKEEPALIVE_PEERS=Set to all or a list of comma separated peers (ie. 1,4,laptop) for the wireguard server to send keepalive packets to listed peers every 25 seconds. Useful if server is accessed via domain name and has dynamic IP. Used only in server mode. LOG_CONFS=trueGenerated QR codes will be displayed in the docker log. Set to false to skip log output.
Volume Mappings (-v)¶
Volume Function /configContains all relevant configuration files. /lib/modulesHost kernel modules for situations where they're not already loaded.
Miscellaneous Options¶
Parameter Function --sysctl=Required for client mode.
Portainer notice¶
{% hint style="warning" %} This image utilises cap_add or sysctl to work properly. This is not implemented properly in some versions of Portainer, thus this image may not work if deployed through Portainer.
Environment variables from files (Docker secrets)¶
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
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:
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 wireguard /bin/bash- To monitor the logs of the container in realtime:
docker logs -f wireguard- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' wireguard- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/wireguard:latest
Versions¶
- 28.06.23: - Rebase master to Alpine 3.18 again.
- 26.06.23: - Revert master to Alpine 3.17, due to issue with openresolv.
- 24.06.23: - Rebase master to Alpine 3.18, deprecate armhf as per https://www.linuxserver.io/armhf.
- 26.04.23: - Rework branches. Swap alpine and ubuntu builds.
- 29.01.23: - Rebase to alpine 3.17.
- 10.01.23: - Add new var to add
PersistentKeepalive to server config for select peers to survive server IP changes when domain name is used. - 26.10.22: - Better handle unsupported peer names. Improve logging.
- 12.10.22: - Add Alpine branch. Optimize wg and coredns services.
- 04.10.22: - Rebase to Jammy. Upgrade to s6v3.
- 16.05.22: - Improve NAT handling in server mode when multiple ethernet devices are present.
- 23.04.22: - Add pre-shared key support. Automatically added to all new peer confs generated, existing ones are left without to ensure no breaking changes.
- 10.04.22: - Rebase to Ubuntu Focal. Add
LOG_CONFS env var. Remove deprecated add-peer command. - 28.10.21: - Add site-to-site vpn support.
- 11.02.21: - Fix bug related to changing internal subnet and named peer confs not updating.
- 06.10.20: - Disable CoreDNS in client mode, or if port 53 is already in use in server mode.
- 04.10.20: - Allow to specify a list of names as PEERS and add ALLOWEDIPS environment variable. Also, add peer name/id to each one of the peer sections in wg0.conf. Important: Existing users need to delete
/config/templates/peer.conf and restart - 27.09.20: - Cleaning service binding example to have accurate PreDown script.
- 06.08.20: - Replace resolvconf with openresolv due to dns issues when a client based on this image is connected to a server also based on this image. Add IPv6 info to readme. Display kernel version in logs.
- 29.07.20: - Update Coredns config to detect dns loops (existing users need to delete
/config/coredns/Corefile and restart). - 27.07.20: - Update Coredns config to prevent issues with non-user-defined bridge networks (existing users need to delete
/config/coredns/Corefile and restart). - 05.07.20: - Add Debian updates and security repos for headers.
- 25.06.20: - Simplify module tests, prevent iptables issues from resulting in false negatives.
- 19.06.20: - Add support for Ubuntu Focal (20.04) kernels. Compile wireguard tools and kernel module instead of using the ubuntu packages. Make module install optional. Improve verbosity in logs.
- 29.05.20: - Add support for 64bit raspbian.
- 28.04.20: - Add Buster/Stretch backports repos for Debian. Tested with OMV 5 and OMV 4 (on kernel 4.19.0-0.bpo.8-amd64).
- 20.04.20: - Fix typo in client mode conf existence check.
- 13.04.20: - Fix bug that forced conf recreation on every start.
- 08.04.20: - Add arm32/64 builds and enable multi-arch (rpi4 with ubuntu and raspbian buster tested). Add CoreDNS for
PEERDNS=auto setting. Update the add-peer/show-peer scripts to utilize the templates and the INTERNAL_SUBNET var (previously missed, oops). - 05.04.20: - Add
INTERNAL_SUBNET variable to prevent subnet clashes. Add templates for server and peer confs. - 01.04.20: - Add
show-peer script and include info on host installed headers. - 31.03.20: - Initial Release.
\ No newline at end of file
+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 wireguard /bin/bash- To monitor the logs of the container in realtime:
docker logs -f wireguard- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' wireguard- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/wireguard:latest
Versions¶
- 28.06.23: - Rebase master to Alpine 3.18 again.
- 26.06.23: - Revert master to Alpine 3.17, due to issue with openresolv.
- 24.06.23: - Rebase master to Alpine 3.18, deprecate armhf as per https://www.linuxserver.io/armhf.
- 26.04.23: - Rework branches. Swap alpine and ubuntu builds.
- 29.01.23: - Rebase to alpine 3.17.
- 10.01.23: - Add new var to add
PersistentKeepaliveto server config for select peers to survive server IP changes when domain name is used. - 26.10.22: - Better handle unsupported peer names. Improve logging.
- 12.10.22: - Add Alpine branch. Optimize wg and coredns services.
- 04.10.22: - Rebase to Jammy. Upgrade to s6v3.
- 16.05.22: - Improve NAT handling in server mode when multiple ethernet devices are present.
- 23.04.22: - Add pre-shared key support. Automatically added to all new peer confs generated, existing ones are left without to ensure no breaking changes.
- 10.04.22: - Rebase to Ubuntu Focal. Add
LOG_CONFSenv var. Remove deprecatedadd-peercommand. - 28.10.21: - Add site-to-site vpn support.
- 11.02.21: - Fix bug related to changing internal subnet and named peer confs not updating.
- 06.10.20: - Disable CoreDNS in client mode, or if port 53 is already in use in server mode.
- 04.10.20: - Allow to specify a list of names as PEERS and add ALLOWEDIPS environment variable. Also, add peer name/id to each one of the peer sections in wg0.conf. Important: Existing users need to delete
/config/templates/peer.confand restart - 27.09.20: - Cleaning service binding example to have accurate PreDown script.
- 06.08.20: - Replace resolvconf with openresolv due to dns issues when a client based on this image is connected to a server also based on this image. Add IPv6 info to readme. Display kernel version in logs.
- 29.07.20: - Update Coredns config to detect dns loops (existing users need to delete
/config/coredns/Corefileand restart). - 27.07.20: - Update Coredns config to prevent issues with non-user-defined bridge networks (existing users need to delete
/config/coredns/Corefileand restart). - 05.07.20: - Add Debian updates and security repos for headers.
- 25.06.20: - Simplify module tests, prevent iptables issues from resulting in false negatives.
- 19.06.20: - Add support for Ubuntu Focal (20.04) kernels. Compile wireguard tools and kernel module instead of using the ubuntu packages. Make module install optional. Improve verbosity in logs.
- 29.05.20: - Add support for 64bit raspbian.
- 28.04.20: - Add Buster/Stretch backports repos for Debian. Tested with OMV 5 and OMV 4 (on kernel 4.19.0-0.bpo.8-amd64).
- 20.04.20: - Fix typo in client mode conf existence check.
- 13.04.20: - Fix bug that forced conf recreation on every start.
- 08.04.20: - Add arm32/64 builds and enable multi-arch (rpi4 with ubuntu and raspbian buster tested). Add CoreDNS for
PEERDNS=autosetting. Update theadd-peer/show-peerscripts to utilize the templates and theINTERNAL_SUBNETvar (previously missed, oops). - 05.04.20: - Add
INTERNAL_SUBNETvariable to prevent subnet clashes. Add templates for server and peer confs. - 01.04.20: - Add
show-peerscript and include info on host installed headers. - 31.03.20: - Initial Release.
linuxserver/wireshark¶
Wireshark is the world’s foremost and widely-used network protocol analyzer. It lets you see what’s happening on your network at a microscopic level and is the de facto (and often de jure) standard across many commercial and non-profit enterprises, government agencies, and educational institutions. Wireshark development thrives thanks to the volunteer contributions of networking experts around the globe and is the continuation of a project started by Gerald Combs in 1998.
Supported Architectures¶
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/wireshark:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
In order to dump from an interface you will need to pass NET_ADMIN at a minimum, optionally you can use host networking to capture from your host level device or specify a Docker network you want to capture from.
The application can be accessed at:
- http://yourhost:3000/
- https://yourhost:3001/
Options in all KasmVNC based GUI containers¶
This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.
Optional environment variables¶
| Variable | Description |
|---|---|
| CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default 3000. |
| CUSTOM_HTTPS_PORT | Internal port the container listens on for https if it needs to be swapped from the default 3001. |
| CUSTOM_USER | HTTP Basic auth username, abc is default. |
| PASSWORD | HTTP Basic auth password, abc is default. If unset there will be no auth |
| SUBFOLDER | Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/ |
| TITLE | The page title displayed on the web browser, default "KasmVNC Client". |
| FM_HOME | This is the home directory (landing) for the file manager, default "/config". |
| START_DOCKER | If set to false a container with privilege will not automatically start the DinD Docker setup. |
| DRINODE | If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE /dev/dri/renderD128 |
Optional run configurations¶
| Variable | Description |
|---|---|
--privileged | Will start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE -v /home/user/docker-data:/var/lib/docker. |
-v /var/run/docker.sock:/var/run/docker.sock | Mount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. |
--device /dev/dri:/dev/dri | Mount a GPU into the container, this can be used in conjunction with the DRINODE environment variable to leverage a host video card for GPU accelerated appplications. Only Open Source drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau) |
Lossless mode¶
This container is capable of delivering a true lossless image at a high framerate to your web browser by changing the Stream Quality preset to "Lossless", more information here. In order to use this mode from a non localhost endpoint the HTTPS port on 3001 needs to be used. If using a reverse proxy to port 3000 specific headers will need to be set as outlined here.
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)¶
---
+ wireshark - LinuxServer.io linuxserver/wireshark¶
Wireshark is the world’s foremost and widely-used network protocol analyzer. It lets you see what’s happening on your network at a microscopic level and is the de facto (and often de jure) standard across many commercial and non-profit enterprises, government agencies, and educational institutions. Wireshark development thrives thanks to the volunteer contributions of networking experts around the globe and is the continuation of a project started by Gerald Combs in 1998.
Supported Architectures¶
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/wireshark:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
In order to dump from an interface you will need to pass NET_ADMIN at a minimum, optionally you can use host networking to capture from your host level device or specify a Docker network you want to capture from.
The application can be accessed at:
- http://yourhost:3000/
- https://yourhost:3001/
Options in all KasmVNC based GUI containers¶
This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.
Optional environment variables¶
Variable Description CUSTOM_PORT Internal port the container listens on for http if it needs to be swapped from the default 3000. CUSTOM_HTTPS_PORT Internal port the container listens on for https if it needs to be swapped from the default 3001. CUSTOM_USER HTTP Basic auth username, abc is default. PASSWORD HTTP Basic auth password, abc is default. If unset there will be no auth SUBFOLDER Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/ TITLE The page title displayed on the web browser, default "KasmVNC Client". FM_HOME This is the home directory (landing) for the file manager, default "/config". START_DOCKER If set to false a container with privilege will not automatically start the DinD Docker setup. DRINODE If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE /dev/dri/renderD128
Optional run configurations¶
Variable Description --privilegedWill start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE -v /home/user/docker-data:/var/lib/docker. -v /var/run/docker.sock:/var/run/docker.sockMount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. --device /dev/dri:/dev/driMount a GPU into the container, this can be used in conjunction with the DRINODE environment variable to leverage a host video card for GPU accelerated appplications. Only Open Source drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau)
Lossless mode¶
This container is capable of delivering a true lossless image at a high framerate to your web browser by changing the Stream Quality preset to "Lossless", more information here. In order to use this mode from a non localhost endpoint the HTTPS port on 3001 needs to be used. If using a reverse proxy to port 3000 specific headers will need to be set as outlined here.
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)¶
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 3000WireShark desktop gui, only use this if you are not using host mode and sniffing Docker network traffic. 3001WireShark desktop gui HTTPS, only use this if you are not using host mode and sniffing Docker network traffic.
Networking (--net)¶
Parameter Function --net=hostUse Host Networking
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configUsers home directory in the container, stores program settings and potentially dump files.
Miscellaneous Options¶
Parameter Function --security-opt seccomp=unconfinedFor Docker Engine only, many modern gui apps need this to function on older hosts as syscalls are unknown to Docker.
Portainer notice¶
{% hint style="warning" %} This image utilises cap_add or sysctl to work properly. This is not implemented properly in some versions of Portainer, thus this image may not work if deployed through Portainer.
Environment variables from files (Docker secrets)¶
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
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:
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 wireshark /bin/bash- To monitor the logs of the container in realtime:
docker logs -f wireshark- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' wireshark- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/wireshark:latest
Versions¶
- 13.05.23: - Rebase to Alpine 3.18.
- 18.03.23: - Rebase to KasmVNC base image.
- 23.10.22: - Rebase to Alpine 3.16, migrate to s6v3.
- 14.02.22: - Rebase to Alpine.
- 31.03.20: - Initial release.
\ No newline at end of file
+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 wireshark /bin/bash- To monitor the logs of the container in realtime:
docker logs -f wireshark- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' wireshark- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/wireshark:latest
Versions¶
- 13.05.23: - Rebase to Alpine 3.18.
- 18.03.23: - Rebase to KasmVNC base image.
- 23.10.22: - Rebase to Alpine 3.16, migrate to s6v3.
- 14.02.22: - Rebase to Alpine.
- 31.03.20: - Initial release.
linuxserver/wps-office¶
WPS Office is a lightweight, feature-rich comprehensive office suite with high compatibility. As a handy and professional office software, WPS Office allows you to edit files in Writer, Presentation, Spreadsheet, and PDF to improve your work efficiency.
Supported Architectures¶
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/wps-office:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ❌ | |
| armhf | ❌ |
Application Setup¶
The application can be accessed at:
- http://yourhost:3000/
- https://yourhost:3001/
Options in all KasmVNC based GUI containers¶
This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.
Optional environment variables¶
| Variable | Description |
|---|---|
| CUSTOM_PORT | Internal port the container listens on for http if it needs to be swapped from the default 3000. |
| CUSTOM_HTTPS_PORT | Internal port the container listens on for https if it needs to be swapped from the default 3001. |
| CUSTOM_USER | HTTP Basic auth username, abc is default. |
| PASSWORD | HTTP Basic auth password, abc is default. If unset there will be no auth |
| SUBFOLDER | Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/ |
| TITLE | The page title displayed on the web browser, default "KasmVNC Client". |
| FM_HOME | This is the home directory (landing) for the file manager, default "/config". |
| START_DOCKER | If set to false a container with privilege will not automatically start the DinD Docker setup. |
| DRINODE | If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE /dev/dri/renderD128 |
Optional run configurations¶
| Variable | Description |
|---|---|
--privileged | Will start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE -v /home/user/docker-data:/var/lib/docker. |
-v /var/run/docker.sock:/var/run/docker.sock | Mount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. |
--device /dev/dri:/dev/dri | Mount a GPU into the container, this can be used in conjunction with the DRINODE environment variable to leverage a host video card for GPU accelerated appplications. Only Open Source drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau) |
Lossless mode¶
This container is capable of delivering a true lossless image at a high framerate to your web browser by changing the Stream Quality preset to "Lossless", more information here. In order to use this mode from a non localhost endpoint the HTTPS port on 3001 needs to be used. If using a reverse proxy to port 3000 specific headers will need to be set as outlined here.
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)¶
---
+ wps-office - LinuxServer.io linuxserver/wps-office¶
WPS Office is a lightweight, feature-rich comprehensive office suite with high compatibility. As a handy and professional office software, WPS Office allows you to edit files in Writer, Presentation, Spreadsheet, and PDF to improve your work efficiency.
Supported Architectures¶
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/wps-office:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ❌ armhf ❌
Application Setup¶
The application can be accessed at:
- http://yourhost:3000/
- https://yourhost:3001/
Options in all KasmVNC based GUI containers¶
This container is based on Docker Baseimage KasmVNC which means there are additional environment variables and run configurations to enable or disable specific functionality.
Optional environment variables¶
Variable Description CUSTOM_PORT Internal port the container listens on for http if it needs to be swapped from the default 3000. CUSTOM_HTTPS_PORT Internal port the container listens on for https if it needs to be swapped from the default 3001. CUSTOM_USER HTTP Basic auth username, abc is default. PASSWORD HTTP Basic auth password, abc is default. If unset there will be no auth SUBFOLDER Subfolder for the application if running a subfolder reverse proxy, need both slashes IE /subfolder/ TITLE The page title displayed on the web browser, default "KasmVNC Client". FM_HOME This is the home directory (landing) for the file manager, default "/config". START_DOCKER If set to false a container with privilege will not automatically start the DinD Docker setup. DRINODE If mounting in /dev/dri for DRI3 GPU Acceleration allows you to specify the device to use IE /dev/dri/renderD128
Optional run configurations¶
Variable Description --privilegedWill start a Docker in Docker (DinD) setup inside the container to use docker in an isolated environment. For increased performance mount the Docker directory inside the container to the host IE -v /home/user/docker-data:/var/lib/docker. -v /var/run/docker.sock:/var/run/docker.sockMount in the host level Docker socket to either interact with it via CLI or use Docker enabled applications. --device /dev/dri:/dev/driMount a GPU into the container, this can be used in conjunction with the DRINODE environment variable to leverage a host video card for GPU accelerated appplications. Only Open Source drivers are supported IE (Intel,AMDGPU,Radeon,ATI,Nouveau)
Lossless mode¶
This container is capable of delivering a true lossless image at a high framerate to your web browser by changing the Stream Quality preset to "Lossless", more information here. In order to use this mode from a non localhost endpoint the HTTPS port on 3001 needs to be used. If using a reverse proxy to port 3000 specific headers will need to be set as outlined here.
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)¶
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 3000WPS Office desktop gui. 3001WPS Office desktop gui HTTPS.
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configUsers home directory in the container, stores program settings and documents
Miscellaneous Options¶
Parameter Function --shm-size=This is needed for electron applications to function properly. --security-opt seccomp=unconfinedFor Docker Engine only, many modern gui apps need this to function on older hosts as syscalls are unknown to Docker.
Environment variables from files (Docker secrets)¶
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
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:
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 wps-office /bin/bash- To monitor the logs of the container in realtime:
docker logs -f wps-office- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' wps-office- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/wps-office:latest
Versions¶
- 21.04.23: - Initial release.
\ No newline at end of file
+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 wps-office /bin/bash- To monitor the logs of the container in realtime:
docker logs -f wps-office- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' wps-office- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/wps-office:latest
Versions¶
- 21.04.23: - Initial release.
linuxserver/xbackbone¶
Xbackbone is a simple, self-hosted, lightweight PHP file manager that support the instant sharing tool ShareX and *NIX systems. It supports uploading and displaying images, GIF, video, code, formatted text, and file downloading and uploading. Also have a web UI with multi user management, past uploads history and search support.
Supported Architectures¶
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/xbackbone:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
Access the WebUI at <your-ip>:80/443. Follow the installation wizard. For more information, check out XBackBone.
If you want to change the PHP max upload size you can override the php.ini file by adding options in /config/php/php-local.ini
Example:
upload_max_filesize = 25M
+ xbackbone - LinuxServer.io linuxserver/xbackbone¶
Xbackbone is a simple, self-hosted, lightweight PHP file manager that support the instant sharing tool ShareX and *NIX systems. It supports uploading and displaying images, GIF, video, code, formatted text, and file downloading and uploading. Also have a web UI with multi user management, past uploads history and search support.
Supported Architectures¶
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/xbackbone:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
Access the WebUI at <your-ip>:80/443. Follow the installation wizard. For more information, check out XBackBone.
If you want to change the PHP max upload size you can override the php.ini file by adding options in /config/php/php-local.ini
Example:
For reverse proxying, remember to change the base_url in /config/www/xbackbone/config.php to your domain if you initially set up the application with a local url. E.g. 'base_url' => 'https://images.yourdomain.com',
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)¶
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 80http gui 443https gui
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configconfig directory volume mapping
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:
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:
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 xbackbone /bin/bash- To monitor the logs of the container in realtime:
docker logs -f xbackbone- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' xbackbone- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/xbackbone:latest
Versions¶
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 13.04.23: - Move ssl.conf include to default.conf.
- 19.01.23: - Rebase to alpine 3.17 with php8.1.
- 04.11.22: - Rebase to Alpine 3.16, migrate to s6v3.
- 01.11.22: - Move application install to /app/www/public, add migration notices for existing users. Container updates should now update the application correctly
- 20.08.22: - Rebasing to alpine 3.15 with php8. Restructure nginx configs (see changes announcement).
- 02.08.22: - Added note about updating.
- 06.06.21: - Initial Release.
\ No newline at end of file
+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 xbackbone /bin/bash- To monitor the logs of the container in realtime:
docker logs -f xbackbone- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' xbackbone- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/xbackbone:latest
Versions¶
- 25.05.23: - Rebase to Alpine 3.18, deprecate armhf.
- 13.04.23: - Move ssl.conf include to default.conf.
- 19.01.23: - Rebase to alpine 3.17 with php8.1.
- 04.11.22: - Rebase to Alpine 3.16, migrate to s6v3.
- 01.11.22: - Move application install to /app/www/public, add migration notices for existing users. Container updates should now update the application correctly
- 20.08.22: - Rebasing to alpine 3.15 with php8. Restructure nginx configs (see changes announcement).
- 02.08.22: - Added note about updating.
- 06.06.21: - Initial Release.
linuxserver/your_spotify¶
Your_spotify is a self-hosted application that tracks what you listen and offers you a dashboard to explore statistics about it! It's composed of a web server which polls the Spotify API every now and then and a web application on which you can explore your statistics.
Supported Architectures¶
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/your_spotify:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
You have to create a Spotify application through their developer dashboard to get your Client ID and secret. Set the Redirect URI to match your APP_URL address with /api/oauth/spotify/callback included after the domain (i.e., http://localhost/api/oauth/spotify/callback).
The application requires an external mongodb database, supported versions are 4.x, 5.x, and 6.x.
This ia an all-in-one container which includes both the server and client components. If you require these to be separate then please use the releases from the your_spotify repo.
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)¶
---
+ your_spotify - LinuxServer.io linuxserver/your_spotify¶
Your_spotify is a self-hosted application that tracks what you listen and offers you a dashboard to explore statistics about it! It's composed of a web server which polls the Spotify API every now and then and a web application on which you can explore your statistics.
Supported Architectures¶
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/your_spotify:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
You have to create a Spotify application through their developer dashboard to get your Client ID and secret. Set the Redirect URI to match your APP_URL address with /api/oauth/spotify/callback included after the domain (i.e., http://localhost/api/oauth/spotify/callback).
The application requires an external mongodb database, supported versions are 4.x, 5.x, and 6.x.
This ia an all-in-one container which includes both the server and client components. If you require these to be separate then please use the releases from the your_spotify repo.
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)¶
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 80your_spotify HTTP webui 443your_spotify HTTPS webui
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list. APP_URL=http://localhostThe protocol and hostname where the app will be accessed. SPOTIFY_PUBLIC=Your Spotify application client ID. SPOTIFY_SECRET=Your Spotify application secret. CORS=http://localhost:80,https://localhost:443Allowed CORS sources, set to all to allow any source. MONGO_ENDPOINT=mongodb://mongo:27017/your_spotifySet mongodb endpoint address/port.
Volume Mappings (-v)¶
Volume Function
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:
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:
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 your_spotify /bin/bash- To monitor the logs of the container in realtime:
docker logs -f your_spotify- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' your_spotify- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/your_spotify:latest
Versions¶
- 23.01.23: - Rebase to Alpine 3.18, standardize nginx default site conf.
- 23.01.23: - Initial Release.
\ No newline at end of file
+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 your_spotify /bin/bash- To monitor the logs of the container in realtime:
docker logs -f your_spotify- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' your_spotify- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/your_spotify:latest
Versions¶
- 23.01.23: - Rebase to Alpine 3.18, standardize nginx default site conf.
- 23.01.23: - Initial Release.
The LinuxServer.io team brings you another container release featuring:
- regular and timely application updates
- easy user mappings (PGID, PUID)
- custom base image with s6 overlay
- weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
- regular security updates
Find us at: * Blog - all the things you can do with our containers including How-To guides, opinions and much more! * Discord - realtime support / chat with the community and the team. * Discourse - post on our community forum. * Fleet - an online web interface which displays all of our maintained images. * GitHub - view the source for all of our repositories. * Open Collective - please consider helping us by either donating or contributing to our budget
linuxserver/yq¶
yq: Command-line YAML/XML processor - jq wrapper for YAML and XML documents. This image includes yq, jq, and xq.
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 linuxserver/yq 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 | amd64-latest |
| arm64 | arm64v8-latest |
| armhf | arm32v7-latest |
Usage¶
Docker cli¶
docker run --rm \
+ yq - LinuxServer.io
The LinuxServer.io team brings you another container release featuring:
- regular and timely application updates
- easy user mappings (PGID, PUID)
- custom base image with s6 overlay
- weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
- regular security updates
Find us at: * Blog - all the things you can do with our containers including How-To guides, opinions and much more! * Discord - realtime support / chat with the community and the team. * Discourse - post on our community forum. * Fleet - an online web interface which displays all of our maintained images. * GitHub - view the source for all of our repositories. * Open Collective - please consider helping us by either donating or contributing to our budget
linuxserver/yq¶
yq: Command-line YAML/XML processor - jq wrapper for YAML and XML documents. This image includes yq, jq, and xq.
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 linuxserver/yq 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 amd64-latest arm64 arm64v8-latest armhf arm32v7-latest
Usage¶
Docker cli¶
docker run --rm \
-v "$PWD:$PWD" \
-w="$PWD" \
--entrypoint yq \
@@ -29,4 +29,4 @@
--pull \
-t linuxserver/yq:latest .
The ARM variants can be built on x86_64 hardware using multiarch/qemu-user-static
Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.
Versions¶
- 19.09.22: - Rebase to Alpine 3.18, deprecate armhf.
- 19.09.22: - Rebase to 3.17.
- 19.09.22: - Rebase to 3.15.
- 18.05.21: - Rebase to 3.13. add linuxserver wheel repo.
- 09.10.20: - Fix run scripts evaluating
$ in cases where they should not (ex: inside single quotes). Please rerun the Recommended method install/setup commands. - 07.10.20: - Initial Release.
\ No newline at end of file
+Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.
Versions¶
- 19.09.22: - Rebase to Alpine 3.18, deprecate armhf.
- 19.09.22: - Rebase to 3.17.
- 19.09.22: - Rebase to 3.15.
- 18.05.21: - Rebase to 3.13. add linuxserver wheel repo.
- 09.10.20: - Fix run scripts evaluating
$in cases where they should not (ex: inside single quotes). Please rerun the Recommended method install/setup commands. - 07.10.20: - Initial Release.
linuxserver/znc¶
Znc is an IRC network bouncer or BNC. It can detach the client from the actual IRC server, and also from selected channels. Multiple clients from different locations can connect to a single ZNC account simultaneously and therefore appear under the same nickname on IRC.
Supported Architectures¶
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/znc:latest 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 | Available | Tag |
|---|---|---|
| x86-64 | ✅ | amd64-<version tag> |
| arm64 | ✅ | arm64v8-<version tag> |
| armhf | ❌ |
Application Setup¶
To log in to the application, browse to http://
- Default User: admin
- Default Password: admin
change password ASAP.
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)¶
---
+ znc - LinuxServer.io linuxserver/znc¶
Znc is an IRC network bouncer or BNC. It can detach the client from the actual IRC server, and also from selected channels. Multiple clients from different locations can connect to a single ZNC account simultaneously and therefore appear under the same nickname on IRC.
Supported Architectures¶
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/znc:latest 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 Available Tag x86-64 ✅ amd64-<version tag> arm64 ✅ arm64v8-<version tag> armhf ❌
Application Setup¶
To log in to the application, browse to http://:6501.
- Default User: admin
- Default Password: admin
change password ASAP.
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)¶
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 6501Port ZNC listens on.
Environment Variables (-e)¶
Env Function PUID=1000for UserID - see below for explanation PGID=1000for GroupID - see below for explanation TZ=Etc/UTCspecify a timezone to use, see this list.
Volume Mappings (-v)¶
Volume Function /configWhere local ZNC data is stored.
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:
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:
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 znc /bin/bash- To monitor the logs of the container in realtime:
docker logs -f znc- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' znc- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/znc:latest
Versions¶
- 12.07.23: - Rebasing to Alpine 3.18.
- 07.07.23: - Deprecate armhf. As announced here
- 13.02.23: - Rebase to Alpine 3.17, migrate to s6v3.
- 19.01.22: - Rebasing to alpine 3.15.
- 01.06.20: - Rebasing to alpine 3.12.
- 19.12.19: - Rebasing to alpine 3.11.
- 02.11.19: - Add znc-palaver module.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebasing to alpine 3.9.
- 31.01.19: - Add pipeline logic and multi arch.
- 30.01.19: - Add push and clientbuffer modules.
- 17.08.18: - Rebase to alpine 3.8, use buildstage.
- 03.01.18: - Deprecate cpu_core routine lack of scaling.
- 07.12.17: - Rebase alpine linux 3.7.
- 25.10.17: - Remove debug switch from run command.
- 26.05.17: - Rebase alpine linux 3.6.
- 06.02.17: - Rebase alpine linux 3.5.
- 19.01.17: - Add playback module.
- 07.01.17: - Add ca-certificates package, resolve sasl issues.
- 07.12.16: - Use scanelf to determine runtime dependencies. Fix error with continuation.
- 14.10.16: - Add version layer information.
- 30.09.16: - Fix umask.
- 11.09.16: - Add layer badges to README.
- 28.08.16: - Add badges to README.
- 20.08.16: - Rebase to alpine linux, move to main repository.
- 11.12.15: - Initial Release.
\ No newline at end of file
+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 znc /bin/bash- To monitor the logs of the container in realtime:
docker logs -f znc- Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' znc- Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/znc:latest
Versions¶
- 12.07.23: - Rebasing to Alpine 3.18.
- 07.07.23: - Deprecate armhf. As announced here
- 13.02.23: - Rebase to Alpine 3.17, migrate to s6v3.
- 19.01.22: - Rebasing to alpine 3.15.
- 01.06.20: - Rebasing to alpine 3.12.
- 19.12.19: - Rebasing to alpine 3.11.
- 02.11.19: - Add znc-palaver module.
- 28.06.19: - Rebasing to alpine 3.10.
- 23.03.19: - Switching to new Base images, shift to arm32v7 tag.
- 22.02.19: - Rebasing to alpine 3.9.
- 31.01.19: - Add pipeline logic and multi arch.
- 30.01.19: - Add push and clientbuffer modules.
- 17.08.18: - Rebase to alpine 3.8, use buildstage.
- 03.01.18: - Deprecate cpu_core routine lack of scaling.
- 07.12.17: - Rebase alpine linux 3.7.
- 25.10.17: - Remove debug switch from run command.
- 26.05.17: - Rebase alpine linux 3.6.
- 06.02.17: - Rebase alpine linux 3.5.
- 19.01.17: - Add playback module.
- 07.01.17: - Add ca-certificates package, resolve sasl issues.
- 07.12.16: - Use scanelf to determine runtime dependencies. Fix error with continuation.
- 14.10.16: - Add version layer information.
- 30.09.16: - Fix umask.
- 11.09.16: - Add layer badges to README.
- 28.08.16: - Add badges to README.
- 20.08.16: - Rebase to alpine linux, move to main repository.
- 11.12.15: - Initial Release.
Images¶
Each of our images requires their own specific configuration before you can begin making use of them. If you're new to our images, please take the time to read through our documentation.
Images¶
Each of our images requires their own specific configuration before you can begin making use of them. If you're new to our images, please take the time to read through our documentation.
Introduction¶
Welcome to the home of the LinuxServer.io documentation! It is our goal to ensure that all of our images are properly documented with all of the relevant information, in order to help our users get started. In addition to individual set up guides for each image, there is also general information, and best practices, pertaining to running Docker containers.
Want to get hold of the team?¶
The team resides primarily in our Discord server. We also have a forum if chat isn't your thing.
| Where | Link |
|---|---|
| Discord | https://discord.gg/YWrKVTn |
| Forum | https://discourse.linuxserver.io |
For those interested in our CI environment via Jenkins: https://ci.linuxserver.io/
Introduction¶
Welcome to the home of the LinuxServer.io documentation! It is our goal to ensure that all of our images are properly documented with all of the relevant information, in order to help our users get started. In addition to individual set up guides for each image, there is also general information, and best practices, pertaining to running Docker containers.
Want to get hold of the team?¶
The team resides primarily in our Discord server. We also have a forum if chat isn't your thing.
| Where | Link |
|---|---|
| Discord | https://discord.gg/YWrKVTn |
| Forum | https://discourse.linuxserver.io |
For those interested in our CI environment via Jenkins: https://ci.linuxserver.io/
Finances¶
- v0.1 Beta (Work in progress)
- Created 2021-08-18
- Updated 2021-08-18
Charter¶
We will at all times attempt to keep a surplus of $6,000 in the bank account, or an amount which covers 3 years of expenses, whichever is higher. All other money will be disbursed by agreement of a general consensus of linuxserver.io staff members.
Annual Expenses¶
- DigitalOcean yearly costs (currently paid for) $1200
- AWS ~$200
- Contabo hosting $287.76
- Email Hosting $20
- Various domains ~$150
- Docker Pro Plan $60
- Various licenses ~$150
Votes¶
In order for money to be approved for a project, the requesting member must go through every effort to bring to vote a fully formed idea that is ready to be actioned. This means that all the legwork is done before bringing an idea to vote, or at least as much as is reasonably possible. A vote will last for 3 days in order to give all team members the opportunity to participate without unnecessarily causing delays. A general consensus will need to be reached in order for it to proceed.
Acceptable uses of money¶
- Hardware/Software needed to help the group reach a specific goal
- Stationary + related items for possible conventions
- Convention fees (Both Attendence and Travel)
- Hosting services (Included domain purchases)
- Good will gestures (Example: For users outside the group that have provided help when asked.)
- Food/Drink for LinuxServer.io focused sprints
- Donations to upstream projects
Links¶
Finances¶
- v0.1 Beta (Work in progress)
- Created 2021-08-18
- Updated 2021-08-18
Charter¶
We will at all times attempt to keep a surplus of $6,000 in the bank account, or an amount which covers 3 years of expenses, whichever is higher. All other money will be disbursed by agreement of a general consensus of linuxserver.io staff members.
Annual Expenses¶
- DigitalOcean yearly costs (currently paid for) $1200
- AWS ~$200
- Contabo hosting $287.76
- Email Hosting $20
- Various domains ~$150
- Docker Pro Plan $60
- Various licenses ~$150
Votes¶
In order for money to be approved for a project, the requesting member must go through every effort to bring to vote a fully formed idea that is ready to be actioned. This means that all the legwork is done before bringing an idea to vote, or at least as much as is reasonably possible. A vote will last for 3 days in order to give all team members the opportunity to participate without unnecessarily causing delays. A general consensus will need to be reached in order for it to proceed.
Acceptable uses of money¶
- Hardware/Software needed to help the group reach a specific goal
- Stationary + related items for possible conventions
- Convention fees (Both Attendence and Travel)
- Hosting services (Included domain purchases)
- Good will gestures (Example: For users outside the group that have provided help when asked.)
- Food/Drink for LinuxServer.io focused sprints
- Donations to upstream projects