diff --git a/!documentation/Docker Apps/01 docker-infra.md b/!documentation/Docker Apps/01 docker-infra.md index c14421b..cedb9df 100644 --- a/!documentation/Docker Apps/01 docker-infra.md +++ b/!documentation/Docker Apps/01 docker-infra.md @@ -1,6 +1,6 @@ --- date: 2024-07-05 17:59 -update: 2024-07-05T22:56:49-07:00 +update: 2024-07-10T18:44:09-07:00 comments: "true" --- # 01 Docker Infrastructure @@ -14,7 +14,7 @@ All `docker-compose.yml` files are stored in `~/docker` folder, which then by de - the apps share common properties such as `arrs` apps - it is preferable for apps to live in same network, eg. `teslamate` - a large app requiring multiple containers eg. `frontend`, `mysql` etc.. - - apps share similar/same [category](#Categories), such as `qBittorrent` and `nzbget` can be put together in `downloader.yml` even though they do not have common properties or require same networking + - apps share similar/same [category](#categories), such as `qBittorrent` and `nzbget` can be put together in `downloader.yml` even though they do not have common properties or require same networking ##### Storage The storage used for all containers are bind mount. diff --git a/!documentation/Linux Server/olivetin.md b/!documentation/Linux Server/olivetin.md index 707eb07..44a6e04 100644 --- a/!documentation/Linux Server/olivetin.md +++ b/!documentation/Linux Server/olivetin.md @@ -1,6 +1,6 @@ --- date: 2023-09-19T21:15:30.000000Z -update: 2024-07-10T18:38:21-07:00 +update: 2024-07-10T18:43:56-07:00 comments: "true" --- # OliveTin @@ -197,7 +197,7 @@ curl -X POST 'http://mediaserver:1378/api/StartAction' -d '{"actionId": "Rename > ### Dashboard -Dashboard are a separate page from the default OliveTin page, [Fieldsets](#Fieldsets) and [Folders](#Folders) are allowed to group actions only in dashboard. +Dashboard are a separate page from the default OliveTin page, [Fieldsets](#fieldsets) and [Folders](#folders) are allowed to group actions only in dashboard. - when an action is in dashboards, it does not appear in main view. - when refreshing the page, it will always go back to main view even if the page is currently at a dashboard ```yaml @@ -226,11 +226,11 @@ dashboards: - it is possible to use custom icons or title for folders as long as `type: ` is not set and it has `contents: ` ### Entities -To use entities, an [action](#entity%20actions), a [dashboard](#dashboard) [entry](#dashboard%20entry), entities json/yaml [file](#entities.json) and entity update method is needed (when the action interact with the entity). +To use entities, an [action](#entity-actions), a [dashboard](#dashboard) [entry](#dashboard-entry), entities json/yaml [file](#entities-file) and entity update method is needed (when the action interact with the entity). >[!info]- Preview of Entities Flowchart >![](assets/new.drawio.png) -#### entities.json -It's also possible to use [YAML](https://docs.olivetin.app/entities-yaml.html) +#### entities-file +It's possible to use [json](https://docs.olivetin.app/entities-json.html) or [YAML](https://docs.olivetin.app/entities-yaml.html) ```yaml entities: - file: /etc/OliveTin/entities/containers.json @@ -248,8 +248,8 @@ entities: execOnCron: '*/5 * * * *' ``` -- this is an action that is trigger by other actions that need to modify the entity, the purpose is to update [the entity file](#entities.json) -#### entity actions +- this is an action that is trigger by other actions that need to modify the entity, the purpose is to update [the entity file](#entities-file) +#### entity-actions ```yaml - title: Check {{ container.Names }} Status shell: echo {{ container.Status }} @@ -261,7 +261,7 @@ The entity action is defined the same way as other actions. - `entity` need to be defined - `trigger` automatically update entity attributes (since executing this actions could change some attribute of an entity like starting a container) - both title and shell can use `entity.attributes` -#### dashboard entry +#### dashboard-entry ```yaml - title: CPanel contents: @@ -276,4 +276,4 @@ The entity action is defined the same way as other actions. ``` >[!notes]- Preview >![](assets/Pasted%20image%2020240710174307.png) -- dashboard is the same configuration as in [previous](#Dashboard) but now is able to utilize entities. \ No newline at end of file +- dashboard is the same configuration as in [previous](#dashboard) but now is able to utilize entities. \ No newline at end of file diff --git a/!documentation/index.md b/!documentation/index.md index d239b16..91bd516 100644 --- a/!documentation/index.md +++ b/!documentation/index.md @@ -1,13 +1,13 @@ # Home ### Recent Updates -- [OliveTin](olivetin.md) +- [Mkdocs](mkdocs.md) - [01 Docker Infrastructure](01 docker-infra.md) +- [OliveTin](olivetin.md) - [JDownloader](jdownloader.md) - [Samba(SMB) Setup](sambasmb-setup.md) - [Dynamic DNS Updater Docker](ddns-update.md) - [Filebrowser](filebrowser.md) -- [Mkdocs](mkdocs.md) - [Debian-Based Server Setup](debian-based-server-setup.md) - [Tunneling Basic Services (Jellyfin, Web) with Caddy and Tailscale](tunneling-basic-services-jellyfin-web-with-caddy-and-tailscale.md) - [Useful Plugins](useful-plugins.md) diff --git a/!documentation/mkdocs.md b/!documentation/mkdocs.md index f50e625..aa2a08e 100644 --- a/!documentation/mkdocs.md +++ b/!documentation/mkdocs.md @@ -1,11 +1,12 @@ --- comments: "true" -update: 2024-06-28T22:14:32-07:00 +update: 2024-07-10T18:47:00-07:00 --- # Mkdocs ### Mkdocs Gotchas - `yaml` highlighting is broken with `mdx-breakless-lists` - when using heading `#`, if there are no line breaks between headings, any lists that is after content of the second heading will not be rendered properly, even with `mdx-breakless-lists` +- furthermore, if using lists right after a `yaml` code block, the list will also not be rendered correctly - ![](assets/Pasted%20image%2020240531235503.png) - when referencing a subheading in another file, mkdocs uses `[](file.md#heading-with-space)` while obsidian uses `[](file.md#heading%20with%20space)` - Before switching from lists to normal content, a line break is needed, otherwise the text below will be rendered with a indent