8.6 KiB
title |
---|
raneto |
linuxserver/raneto
Raneto - is an open source Knowledgebase platform that uses static Markdown files to power your Knowledgebase.
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/raneto
should retrieve 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 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)
---
version: "2.1"
services:
raneto:
image: lscr.io/linuxserver/raneto
container_name: raneto
environment:
- PUID=1000
- PGID=1000
- TZ=Europe/London
volumes:
- /path/to/appdata:/config
ports:
- 3000:3000
restart: unless-stopped
docker cli (click here for more info)
docker run -d \
--name=raneto \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=Europe/London \
-p 3000:3000 \
-v /path/to/appdata:/config \
--restart unless-stopped \
lscr.io/linuxserver/raneto
Parameters
Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal>
respectively. For example, -p 8080:80
would expose port 80
from inside the container to be accessible from the host's IP on port 8080
outside the container.
Ports (-p
)
Parameter | Function |
---|---|
3000 |
The port for the Raneto web interface |
Environment Variables (-e
)
Env | Function |
---|---|
PUID=1000 |
for UserID - see below for explanation |
PGID=1000 |
for GroupID - see below for explanation |
TZ=Europe/London |
Specify a timezone to use EG Europe/London |
Volume Mappings (-v
)
Volume | Function |
---|---|
/config |
Raneto 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:
-e FILE__PASSWORD=/run/secrets/mysecretpassword
Will set the environment variable PASSWORD
based on the contents of the /run/secrets/mysecretpassword
file.
Umask for running applications
For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022
setting.
Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.
User / Group Identifiers
When using volumes (-v
flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID
and group PGID
.
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
In this instance PUID=1000
and PGID=1000
, to find yours use id user
as below:
$ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
Docker Mods
We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.
Support Info
- Shell access whilst the container is running:
docker exec -it 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
Versions
- 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.