docker-raneto/readme-vars.yml
2023-04-24 18:10:40 +01:00

53 lines
2.5 KiB
YAML

---
# project information
project_name: raneto
project_url: "http://raneto.com/"
project_logo: "https://raw.githubusercontent.com/gilbitron/Raneto/master/logo/logo_readme.png"
project_blurb: "[{{ project_name|capitalize }}]({{ project_url }}) - is an open source Knowledgebase platform that uses static Markdown files to power your Knowledgebase."
project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}"
# supported architectures
available_architectures:
- { arch: "{{ arch_x86_64 }}", tag: "amd64-latest"}
- { arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"}
- { arch: "{{ arch_armhf }}", tag: "arm32v7-latest"}
# container parameters
param_container_name: "{{ project_name }}"
param_usage_include_vols: true
param_volumes:
- { vol_path: "/config", vol_host_path: "/path/to/appdata", desc: "Raneto config and Markdown files" }
param_usage_include_ports: true
param_ports:
- { external_port: "3000", internal_port: "3000", port_desc: "The port for the Raneto web interface" }
param_usage_include_env: true
param_env_vars:
- { env_var: "TZ", env_value: "Europe/London", desc: "Specify a timezone to use EG Europe/London"}
# application setup block
app_setup_block_enabled: true
app_setup_block: |
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.
# changelog
changelogs:
- { date: "21.04.23:", desc: "Fix for upstream changes." }
- { date: "18.01.23:", desc: "Rebase to Alpine 3.17, migrate to s6v3." }
- { date: "10.08.22:", desc: "Rebasing to alpine 3.15." }
- { date: "23.01.21:", desc: "Rebasing to alpine 3.13." }
- { date: "02.06.20:", desc: "Rebasing to alpine 3.11." }
- { date: "19.12.19:", desc: "Rebasing to alpine 3.11." }
- { date: "28.06.19:", desc: "Rebasing to alpine 3.10." }
- { date: "01.06.19:", desc: "Initial Release." }