docker-documentation/docs/images/docker-raneto.md

289 wiersze
12 KiB
Markdown
Czysty Zwykły widok Historia

2021-02-16 15:55:12 +00:00
---
title: raneto
---
2023-10-07 21:53:48 +00:00
<!-- DO NOT EDIT THIS FILE MANUALLY -->
<!-- Please read https://github.com/linuxserver/docker-raneto/blob/master/.github/CONTRIBUTING.md -->
2020-07-02 16:03:16 +00:00
# [linuxserver/raneto](https://github.com/linuxserver/docker-raneto)
2021-12-21 15:53:51 +00:00
[![Scarf.io pulls](https://scarf.sh/installs-badge/linuxserver-ci/linuxserver%2Franeto?color=94398d&label-color=555555&logo-color=ffffff&style=for-the-badge&package-type=docker)](https://scarf.sh/gateway/linuxserver-ci/docker/linuxserver%2Franeto)
2020-07-02 16:03:16 +00:00
[![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-raneto.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-raneto)
[![GitHub Release](https://img.shields.io/github/release/linuxserver/docker-raneto.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-raneto/releases)
[![GitHub Package Repository](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitHub%20Package&logo=github)](https://github.com/linuxserver/docker-raneto/packages)
2020-12-16 18:49:48 +00:00
[![GitLab Container Registry](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=GitLab%20Registry&logo=gitlab)](https://gitlab.com/linuxserver.io/docker-raneto/container_registry)
2021-10-05 16:03:20 +00:00
[![Quay.io](https://img.shields.io/static/v1.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=linuxserver.io&message=Quay.io)](https://quay.io/repository/linuxserver.io/raneto)
2020-07-02 16:03:16 +00:00
[![Docker Pulls](https://img.shields.io/docker/pulls/linuxserver/raneto.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=pulls&logo=docker)](https://hub.docker.com/r/linuxserver/raneto)
[![Docker Stars](https://img.shields.io/docker/stars/linuxserver/raneto.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=stars&logo=docker)](https://hub.docker.com/r/linuxserver/raneto)
[![Jenkins Build](https://img.shields.io/jenkins/build?labelColor=555555&logoColor=ffffff&style=for-the-badge&jobUrl=https%3A%2F%2Fci.linuxserver.io%2Fjob%2FDocker-Pipeline-Builders%2Fjob%2Fdocker-raneto%2Fjob%2Fmaster%2F&logo=jenkins)](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-raneto/job/master/)
2020-11-02 16:28:47 +00:00
[![LSIO CI](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=CI&query=CI&url=https%3A%2F%2Fci-tests.linuxserver.io%2Flinuxserver%2Franeto%2Flatest%2Fci-status.yml)](https://ci-tests.linuxserver.io/linuxserver/raneto/latest/index.html)
2019-06-05 19:06:50 +00:00
[Raneto](http://raneto.com/) - is an open source Knowledgebase platform that uses static Markdown files to power your Knowledgebase.
2023-10-07 21:53:48 +00:00
[![raneto](https://raw.githubusercontent.com/gilbitron/Raneto/master/logo/logo_readme.png)](http://raneto.com/)
2019-06-05 19:06:50 +00:00
## Supported Architectures
2023-11-18 21:53:51 +00:00
We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://distribution.github.io/distribution/spec/manifest-v2-2/#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
2019-06-05 19:06:50 +00:00
2022-05-03 15:54:23 +00:00
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.
2019-06-05 19:06:50 +00:00
The architectures supported by this image are:
2022-05-03 15:54:23 +00:00
| Architecture | Available | Tag |
| :----: | :----: | ---- |
| x86-64 | ✅ | amd64-\<version tag\> |
| arm64 | ✅ | arm64v8-\<version tag\> |
2023-07-01 21:56:52 +00:00
| armhf | ❌ | |
2019-06-05 19:06:50 +00:00
2021-04-20 15:58:42 +00:00
## Application Setup
Access the webui at http://<your-ip>: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](http://docs.raneto.com/usage/creating-pages).
* /config/images - This folder will serve content on http://<your-ip>:3000/images/<image name>.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.
2020-07-02 16:03:16 +00:00
2019-06-05 19:06:50 +00:00
## Usage
2021-07-06 15:55:03 +00:00
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
2019-06-05 19:06:50 +00:00
2021-07-06 15:55:03 +00:00
### docker-compose (recommended, [click here for more info](https://docs.linuxserver.io/general/docker-compose))
2019-06-05 19:06:50 +00:00
```yaml
---
services:
raneto:
2022-05-03 15:54:23 +00:00
image: lscr.io/linuxserver/raneto:latest
2019-06-05 19:06:50 +00:00
container_name: raneto
environment:
- PUID=1000
- PGID=1000
2023-02-14 15:49:20 +00:00
- TZ=Etc/UTC
2019-06-05 19:06:50 +00:00
volumes:
2019-10-12 23:58:10 +00:00
- /path/to/appdata:/config
2019-06-05 19:06:50 +00:00
ports:
- 3000:3000
restart: unless-stopped
```
2021-07-06 15:55:03 +00:00
### docker cli ([click here for more info](https://docs.docker.com/engine/reference/commandline/cli/))
2020-10-08 16:03:27 +00:00
2021-04-20 15:58:42 +00:00
```bash
2020-10-08 16:03:27 +00:00
docker run -d \
--name=raneto \
-e PUID=1000 \
-e PGID=1000 \
2023-02-14 15:49:20 +00:00
-e TZ=Etc/UTC \
2020-10-08 16:03:27 +00:00
-p 3000:3000 \
-v /path/to/appdata:/config \
--restart unless-stopped \
2022-05-03 15:54:23 +00:00
lscr.io/linuxserver/raneto:latest
2020-10-08 16:03:27 +00:00
```
2019-06-05 19:06:50 +00:00
## Parameters
2023-10-07 21:53:48 +00:00
Containers 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.
2019-06-05 19:06:50 +00:00
2020-07-02 16:03:16 +00:00
### Ports (`-p`)
2019-06-05 19:06:50 +00:00
| Parameter | Function |
2020-07-02 16:03:16 +00:00
| :----: | --- |
2019-06-05 19:06:50 +00:00
| `3000` | The port for the Raneto web interface |
2020-07-02 16:03:16 +00:00
### Environment Variables (`-e`)
2019-06-05 19:06:50 +00:00
| Env | Function |
2020-07-02 16:03:16 +00:00
| :----: | --- |
2019-06-05 19:06:50 +00:00
| `PUID=1000` | for UserID - see below for explanation |
| `PGID=1000` | for GroupID - see below for explanation |
2023-02-14 15:49:20 +00:00
| `TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |
2019-06-05 19:06:50 +00:00
2020-07-02 16:03:16 +00:00
### Volume Mappings (`-v`)
2019-06-05 19:06:50 +00:00
| Volume | Function |
2020-07-02 16:03:16 +00:00
| :----: | --- |
2019-06-05 19:06:50 +00:00
| `/config` | Raneto config and Markdown files |
2021-10-05 16:03:20 +00:00
#### Miscellaneous Options
| Parameter | Function |
| :-----: | --- |
2020-07-02 16:03:16 +00:00
## Environment variables from files (Docker secrets)
2020-06-04 16:03:05 +00:00
You can set any environment variable from a file by using a special prepend `FILE__`.
As an example:
2021-04-20 15:58:42 +00:00
```bash
2023-10-07 21:53:48 +00:00
-e FILE__MYVAR=/run/secrets/mysecretvariable
2020-06-04 16:03:05 +00:00
```
2023-10-07 21:53:48 +00:00
Will set the environment variable `MYVAR` based on the contents of the `/run/secrets/mysecretvariable` file.
2020-06-04 16:03:05 +00:00
## Umask for running applications
2020-07-02 16:03:16 +00:00
For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional `-e UMASK=022` setting.
Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up [here](https://en.wikipedia.org/wiki/Umask) before asking for support.
2019-06-05 19:06:50 +00:00
## User / Group Identifiers
2020-07-02 16:03:16 +00:00
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`.
2019-06-05 19:06:50 +00:00
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
2023-10-07 21:53:48 +00:00
In this instance `PUID=1000` and `PGID=1000`, to find yours use `id your_user` as below:
2019-06-05 19:06:50 +00:00
2021-04-20 15:58:42 +00:00
```bash
2023-10-07 21:53:48 +00:00
id your_user
```
Example output:
```text
uid=1000(your_user) gid=1000(your_user) groups=1000(your_user)
2019-06-05 19:06:50 +00:00
```
2020-04-09 16:03:08 +00:00
## Docker Mods
2021-04-20 15:58:42 +00:00
2020-10-08 16:03:27 +00:00
[![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=raneto&query=%24.mods%5B%27raneto%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=raneto "view available mods for this container.") [![Docker Universal Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
2020-04-09 16:03:08 +00:00
2020-10-08 16:03:27 +00:00
We publish various [Docker Mods](https://github.com/linuxserver/docker-mods) to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.
2020-04-09 16:03:08 +00:00
2019-06-05 19:06:50 +00:00
## Support Info
2019-09-05 16:03:37 +00:00
* Shell access whilst the container is running:
2023-10-07 21:53:48 +00:00
```bash
docker exec -it raneto /bin/bash
```
2019-09-05 16:03:37 +00:00
* To monitor the logs of the container in realtime:
2023-10-07 21:53:48 +00:00
```bash
docker logs -f raneto
```
* Container version number:
```bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' raneto
```
* Image version number:
```bash
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/raneto:latest
```
## Updating Info
2024-01-13 21:55:42 +00:00
Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (noted in the relevant readme.md), we do not recommend or support updating apps inside the container. Please consult the [Application Setup](#application-setup) section above to see if it is recommended for the image.
2023-10-07 21:53:48 +00:00
Below are the instructions for updating containers:
### Via Docker Compose
* Update images:
* All images:
```bash
docker-compose pull
```
* Single image:
```bash
docker-compose pull raneto
```
* Update containers:
* All containers:
```bash
docker-compose up -d
```
* Single container:
```bash
docker-compose up -d raneto
```
* You can also remove the old dangling images:
```bash
docker image prune
```
### Via Docker Run
* Update the image:
```bash
docker pull lscr.io/linuxserver/raneto:latest
```
* Stop the running container:
```bash
docker stop raneto
```
* Delete the container:
```bash
docker rm raneto
```
* Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your `/config` folder and settings will be preserved)
* You can also remove the old dangling images:
```bash
docker image prune
```
### Image Update Notifications - Diun (Docker Image Update Notifier)
!!! tip
We recommend [Diun](https://crazymax.dev/diun/) for update notifications. Other tools that automatically update containers unattended are not recommended or supported.
## Building locally
If you want to make local modifications to these images for development purposes or just to customize the logic:
```bash
git clone https://github.com/linuxserver/docker-raneto.git
cd docker-raneto
docker build \
--no-cache \
--pull \
-t lscr.io/linuxserver/raneto:latest .
```
The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static`
```bash
docker run --rm --privileged multiarch/qemu-user-static:register --reset
```
Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`.
2019-06-05 19:06:50 +00:00
## Versions
2023-07-12 14:24:47 +00:00
* **12.07.23:** - Rebase to Alpine 3.18.
2023-07-01 21:56:52 +00:00
* **01.07.23:** - Deprecate armhf. As announced [here](https://www.linuxserver.io/blog/a-farewell-to-arm-hf)
2023-04-24 18:46:32 +00:00
* **21.04.23:** - Fix for upstream changes.
2023-01-19 17:51:15 +00:00
* **18.01.23:** - Rebase to Alpine 3.17, migrate to s6v3.
2022-08-10 16:44:49 +00:00
* **10.08.22:** - Rebasing to alpine 3.15.
2021-02-17 14:09:43 +00:00
* **23.01.21:** - Rebasing to alpine 3.13.
2020-06-06 22:00:42 +00:00
* **02.06.20:** - Rebasing to alpine 3.11.
2019-12-27 10:55:52 +00:00
* **19.12.19:** - Rebasing to alpine 3.11.
2019-07-05 18:31:20 +00:00
* **28.06.19:** - Rebasing to alpine 3.10.
2019-06-05 19:06:50 +00:00
* **01.06.19:** - Initial Release.