From 15f92da9914edb29ace0d8f58c20fe57c63bbe17 Mon Sep 17 00:00:00 2001 From: <> Date: Sun, 26 May 2024 11:50:27 +0000 Subject: [PATCH] Deployed 2bdc60f5 with MkDocs version: 1.6.0 --- images/docker-cops/index.html | 4 ++-- images/docker-obsidian/index.html | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/images/docker-cops/index.html b/images/docker-cops/index.html index 44c1b4f78d..e505cf732c 100644 --- a/images/docker-cops/index.html +++ b/images/docker-cops/index.html @@ -1,4 +1,4 @@ - cops - LinuxServer.io
Skip to content

linuxserver/cops

Scarf.io pulls GitHub Stars GitHub Release GitHub Package Repository GitLab Container Registry Quay.io Docker Pulls Docker Stars Jenkins Build LSIO CI

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.

cops

Supported Architectures

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

---
+ cops - LinuxServer.io      
 
 
  
 
  
 
 
 
 
  
 
 
 
 
 
  
 
 
 
 
   
linuxserver/cops
 
Scarf.io pulls GitHub Stars GitHub Release GitHub Package Repository GitLab Container Registry Quay.io Docker Pulls Docker Stars Jenkins Build LSIO CI
 
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.
 
cops
 
Supported Architectures
 
We 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.
  
---
 services:
   cops:
     image: lscr.io/linuxserver/cops:latest
@@ -48,4 +48,4 @@
   --pull \
   -t lscr.io/linuxserver/cops:latest .
 
 
The ARM variants can be built on x86_64 hardware using multiarch/qemu-user-static
 
docker run --rm --privileged multiarch/qemu-user-static:register --reset
-
 
Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.
 
Versions
 
     
  • 07.05.24: - Existing users should verify: site-confs/default.conf - Fix rewriting rules default site conf.
    •  
  • 20.03.24: - Rebase to Alpine 3.19.
    •  
  • 25.12.23: - Existing users should update: site-confs/default.conf - Cleanup default site conf.
    •  
  • 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
+

Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.

Versions

  • 07.05.24: - Existing users should verify: site-confs/default.conf - Fix rewriting rules default site conf.
  • 20.03.24: - Rebase to Alpine 3.19.
  • 25.12.23: - Existing users should update: site-confs/default.conf - Cleanup default site conf.
  • 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 diff --git a/images/docker-obsidian/index.html b/images/docker-obsidian/index.html index e39d0dc63f..95fdd8e93a 100644 --- a/images/docker-obsidian/index.html +++ b/images/docker-obsidian/index.html @@ -1,4 +1,4 @@ - obsidian - LinuxServer.io
Skip to content

linuxserver/obsidian

Scarf.io pulls GitHub Stars GitHub Release GitHub Package Repository GitLab Container Registry Quay.io Docker Pulls Docker Stars Jenkins Build LSIO CI

Obsidian is a note-taking app that lets you create, link, and organize your notes on your device, with hundreds of plugins and themes to customize your workflow. You can also publish your notes online, access them offline, and sync them securely with end-to-end encryption.

obsidian

Supported Architectures

We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.

Simply pulling lscr.io/linuxserver/obsidian:latest should retrieve the correct image for your arch, but you can also pull specific 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
LC_ALL Set the Language for the container to run as IE fr_FR.UTF-8 ar_AE.UTF-8
NO_DECOR If set the application will run without window borders for use as a PWA.
NO_FULL Do not autmatically fullscreen applications when using openbox.

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)

Language Support - Internationalization

The environment variable LC_ALL can be used to start this image in a different language than English simply pass for example to launch the Desktop session in French LC_ALL=fr_FR.UTF-8. Some languages like Chinese, Japanese, or Korean will be missing fonts needed to render properly known as cjk fonts, but others may exist and not be installed. We only ensure fonts for Latin characters are present. Fonts can be installed with a mod on startup.

To install cjk fonts on startup as an example pass the environment variables:

-e DOCKER_MODS=linuxserver/mods:universal-package-install
+ obsidian - LinuxServer.io      
 
 
  
 
  
 
 
 
 
  
 
 
 
 
 
  
 
 
 
 
   
linuxserver/obsidian
 
Scarf.io pulls GitHub Stars GitHub Release GitHub Package Repository GitLab Container Registry Quay.io Docker Pulls Docker Stars Jenkins Build LSIO CI
 
Obsidian is a note-taking app that lets you create, link, and organize your notes on your device, with hundreds of plugins and themes to customize your workflow. You can also publish your notes online, access them offline, and sync them securely with end-to-end encryption.
 
obsidian
 
Supported Architectures
 
We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.
 
Simply pulling lscr.io/linuxserver/obsidian:latest should retrieve the correct image for your arch, but you can also pull specific 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 
 
 LC_ALL Set the Language for the container to run as IE fr_FR.UTF-8 ar_AE.UTF-8 
 
 NO_DECOR If set the application will run without window borders for use as a PWA. 
 
 NO_FULL Do not autmatically fullscreen applications when using openbox. 
  
 
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) 
  
 
Language Support - Internationalization
 
The environment variable LC_ALL can be used to start this image in a different language than English simply pass for example to launch the Desktop session in French LC_ALL=fr_FR.UTF-8. Some languages like Chinese, Japanese, or Korean will be missing fonts needed to render properly known as cjk fonts, but others may exist and not be installed. We only ensure fonts for Latin characters are present. Fonts can be installed with a mod on startup.
 
To install cjk fonts on startup as an example pass the environment variables:
 
-e DOCKER_MODS=linuxserver/mods:universal-package-install
 -e INSTALL_PACKAGES=fonts-noto-cjk
 -e LC_ALL=zh_CN.UTF-8
 
 
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 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.
  
---
@@ -57,4 +57,4 @@
   --pull \
   -t lscr.io/linuxserver/obsidian:latest .
 
 
The ARM variants can be built on x86_64 hardware using multiarch/qemu-user-static
 
docker run --rm --privileged multiarch/qemu-user-static:register --reset
-
 
Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.
 
Versions
 
     
  • 06.04.24: - Initial release.
    •  
  
 
  
  
  
 
 
 
      
\ No newline at end of file
+

Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.

Versions

  • 06.04.24: - Initial release.
\ No newline at end of file