From 67ee91753450e87b65077ea64bff1e1d77ef75ee Mon Sep 17 00:00:00 2001 From: jamesread Date: Wed, 21 Feb 2024 17:20:10 +0000 Subject: [PATCH] deploy: 6d64a480dba2af1f874e01dbcd8e463e9882759b --- _dropdown_choice_arguments.html | 16 +- _exit_code_127.html | 30 +-- _important_safety_warning.html | 16 +- _introduction_to_arguments.html | 16 +- _misc_api_calls.html | 24 +- _olivetin_api_overview.html | 24 +- _reference.html | 30 +-- _run_as_different_users.html | 14 +- _security.html | 30 +-- _textbox_arguments.html | 16 +- _understanding_exit_codes.html | 32 +-- _yaml_entity_files.html | 362 ++++++++++++++++++++++++++++++ action-container-control.html | 14 +- action-customisation.html | 14 +- action-ping.html | 14 +- action-service.html | 14 +- action-ssh.html | 14 +- actions.html | 14 +- after-completion.html | 14 +- ansible-playbook.html | 14 +- apache-dns.html | 14 +- api-start-action.html | 36 +-- api.html | 22 +- args.html | 22 +- auth-concepts.html | 22 +- auth.html | 22 +- caddy-dns.html | 14 +- caddy-path.html | 14 +- choose-package.html | 14 +- concurrency.html | 14 +- config.html | 14 +- confirmation.html | 16 +- container-dnf.html | 34 +-- create-your-first-action.html | 14 +- dashboards.html | 38 ++-- entities-json.html | 225 +++++++++++++++++++ entities.html | 91 ++------ err-fetch-buttons.html | 30 +-- err-fetch-webui-settings.html | 30 +-- err-js-modules-not-supported.html | 30 +-- examples.html | 14 +- exec-cron.html | 14 +- exec-file-changed.html | 14 +- exec-file-created.html | 14 +- exec-on-demand.html | 14 +- exec-startup.html | 14 +- exec-webhook.html | 14 +- haproxy-dns.html | 14 +- icons.html | 14 +- index.html | 20 +- install-alpine.html | 14 +- install-archbtw.html | 14 +- install-compose.html | 14 +- install-container-vs-service.html | 14 +- install-container.html | 14 +- install-fedora.html | 14 +- install-helm.html | 14 +- install-k8s.html | 14 +- install-linuxpackage.html | 14 +- install-targz.html | 14 +- installation.html | 14 +- jwt.html | 32 +-- log-levels.html | 14 +- multi-inst.html | 34 +-- network-ports.html | 32 +-- nginx-dns.html | 14 +- nginx-path.html | 14 +- no-puid-pgid.html | 30 +-- ports.html | 14 +- powershell.html | 14 +- proxy-guide.html | 14 +- reverse-proxies.html | 14 +- snapsnots.html | 32 +-- sosreport.html | 34 +-- support.html | 30 +-- timeout.html | 14 +- timezone.html | 14 +- toggle-webui.html | 14 +- traefik-docker-compose.html | 14 +- troubleshooting.html | 30 +-- trusted-header.html | 22 +- update-tracking.html | 54 ++--- 82 files changed, 1524 insertions(+), 698 deletions(-) create mode 100644 _yaml_entity_files.html create mode 100644 entities-json.html diff --git a/_dropdown_choice_arguments.html b/_dropdown_choice_arguments.html index fed2a3503..513cb91e9 100644 --- a/_dropdown_choice_arguments.html +++ b/_dropdown_choice_arguments.html @@ -187,19 +187,19 @@

OliveTin

  • 7.5. Confirmation argument
    • -
  • 7.6. Entities +
    • -
  • 7.7. Dashboards +
  • 8. Entities
    • - +
  • 9. Dashboards
    • -
  • 8. Authentication & Authorization +
  • 10. Authentication & Authorization
    • -
  • 9. Reference +
  • 11. Reference
    • -
  • 10. Support & Troubleshooting +
  • 12. Support & Troubleshooting
    • -
  • 11. API +
  • 13. API
    • @@ -252,7 +252,7 @@

    -Last updated 2024-02-21 17:12:29 UTC +Last updated 2024-02-21 17:20:06 UTC
    diff --git a/_exit_code_127.html b/_exit_code_127.html index dac0e36e6..fa423d837 100644 --- a/_exit_code_127.html +++ b/_exit_code_127.html @@ -177,36 +177,40 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization +
    • +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting
    • -
  • 11. API +
  • 13. API
    • -

    10.3. Exit code 127

    +

    12.3. Exit code 127

    Exit code 127 on Linux typically means "command not found". This can be the case when you need to install command in a container image for example.

    @@ -218,7 +222,7 @@

    -Last updated 2024-02-21 17:12:29 UTC +Last updated 2024-02-21 17:20:06 UTC

    diff --git a/_important_safety_warning.html b/_important_safety_warning.html index 119ac1108..fde5afecf 100644 --- a/_important_safety_warning.html +++ b/_important_safety_warning.html @@ -187,19 +187,19 @@

    OliveTin

  • 7.5. Confirmation argument
    • -
  • 7.6. Entities +
    • -
  • 7.7. Dashboards +
  • 8. Entities
    • - +
  • 9. Dashboards
    • -
  • 8. Authentication & Authorization +
  • 10. Authentication & Authorization
    • -
  • 9. Reference +
  • 11. Reference
    • -
  • 10. Support & Troubleshooting +
  • 12. Support & Troubleshooting
    • -
  • 11. API +
  • 13. API
    • @@ -233,7 +233,7 @@

    -Last updated 2024-02-21 17:12:29 UTC +Last updated 2024-02-21 17:20:06 UTC

    diff --git a/_introduction_to_arguments.html b/_introduction_to_arguments.html index 2f81d941b..c6c11ffc4 100644 --- a/_introduction_to_arguments.html +++ b/_introduction_to_arguments.html @@ -187,19 +187,19 @@

    OliveTin

  • 7.5. Confirmation argument
    • -
  • 7.6. Entities +
    • -
  • 7.7. Dashboards +
  • 8. Entities
    • - +
  • 9. Dashboards
    • -
  • 8. Authentication & Authorization +
  • 10. Authentication & Authorization
    • -
  • 9. Reference +
  • 11. Reference
    • -
  • 10. Support & Troubleshooting +
  • 12. Support & Troubleshooting
    • -
  • 11. API +
  • 13. API
    • @@ -236,7 +236,7 @@

    -Last updated 2024-02-21 17:12:29 UTC +Last updated 2024-02-21 17:20:06 UTC
    diff --git a/_misc_api_calls.html b/_misc_api_calls.html index 9ca02b103..77f094ed3 100644 --- a/_misc_api_calls.html +++ b/_misc_api_calls.html @@ -177,19 +177,23 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization
    • -
  • 11. API +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting +
    • +
  • 13. API
    • @@ -198,9 +202,9 @@

    OliveTin

    -

    11.3. Misc API calls

    +

    13.3. Misc API calls

    -

    11.3.1. Example API call: Get the dashboard buttons ("components")

    +

    13.3.1. Example API call: Get the dashboard buttons ("components")

    curl
    @@ -215,7 +219,7 @@

    -Last updated 2024-02-21 17:12:29 UTC +Last updated 2024-02-21 17:20:06 UTC

    diff --git a/_olivetin_api_overview.html b/_olivetin_api_overview.html index 74864f9e4..0ff91c310 100644 --- a/_olivetin_api_overview.html +++ b/_olivetin_api_overview.html @@ -177,19 +177,23 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization
    • -
  • 11. API +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting +
    • +
  • 13. API
    • @@ -198,7 +202,7 @@

    OliveTin

    -

    11.1. OliveTin API Overview

    +

    13.1. OliveTin API Overview

    This section of the documentation is intended for developers, and those who want to hack around with OliveTin and extend it. This page provides a few pointers to get started.

    @@ -215,7 +219,7 @@

    The gRPC API only listens on localhost default, but it can be set to listen publicly. See the network ports documentation for a better description of how the APIs are exposed. Most people do not need to use the gRPC API. The .proto file for the gRPC API is located at the root of the OliveTin Git repository; OliveTin.proto.

    -

    11.1.1. Links

    +

    13.1.1. Links

    diff --git a/_reference.html b/_reference.html index 3c506bf8e..2009fb00e 100644 --- a/_reference.html +++ b/_reference.html @@ -177,36 +177,40 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards +
    • +
  • 10. Authentication & Authorization +
    • +
  • 11. Reference
    • -
  • 10. Support & Troubleshooting +
  • 12. Support & Troubleshooting
    • -
  • 11. API +
  • 13. API
    • -

    9. Reference

    +

    11. Reference

    @@ -238,7 +242,7 @@

    -Last updated 2024-02-21 17:12:29 UTC +Last updated 2024-02-21 17:20:06 UTC

    diff --git a/_security.html b/_security.html index bccdde3be..b43ecd442 100644 --- a/_security.html +++ b/_security.html @@ -177,36 +177,40 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards +
    • +
  • 10. Authentication & Authorization +
    • +
  • 11. Reference
    • -
  • 10. Support & Troubleshooting +
  • 12. Support & Troubleshooting
    • -
  • 11. API +
  • 13. API
    • -

    9.2. Security

    +

    11.2. Security

    OliveTin should be reasonably secure. Here are some security considerations in the design of the app;

    @@ -240,7 +244,7 @@

    diff --git a/_textbox_arguments.html b/_textbox_arguments.html index 686bf5adb..0fbbbe410 100644 --- a/_textbox_arguments.html +++ b/_textbox_arguments.html @@ -187,19 +187,19 @@

    OliveTin

  • 7.5. Confirmation argument
    • -
  • 7.6. Entities +
    • -
  • 7.7. Dashboards +
  • 8. Entities
    • - +
  • 9. Dashboards
    • -
  • 8. Authentication & Authorization +
  • 10. Authentication & Authorization
    • -
  • 9. Reference +
  • 11. Reference
    • -
  • 10. Support & Troubleshooting +
  • 12. Support & Troubleshooting
    • -
  • 11. API +
  • 13. API

    • @@ -309,7 +309,7 @@

    diff --git a/_understanding_exit_codes.html b/_understanding_exit_codes.html index d49f76cc7..927c564a1 100644 --- a/_understanding_exit_codes.html +++ b/_understanding_exit_codes.html @@ -177,36 +177,40 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards +
    • +
  • 10. Authentication & Authorization +
    • +
  • 11. Reference
    • -
  • 10. Support & Troubleshooting +
  • 12. Support & Troubleshooting
    • -
  • 11. API +
  • 13. API

    • -

    9.3. Understanding exit codes

    +

    11.3. Understanding exit codes

    OliveTin just runs commands. If the command exits with an unusual exit code (something other than 0), OliveTin will tell you. Many Linux commands will exit @@ -224,7 +228,7 @@

    -

    9.3.1. Common error codes

    +

    11.3.1. Common error codes

    • @@ -240,7 +244,7 @@

      <

    diff --git a/_yaml_entity_files.html b/_yaml_entity_files.html new file mode 100644 index 000000000..9dc5aba65 --- /dev/null +++ b/_yaml_entity_files.html @@ -0,0 +1,362 @@ + + + + + + + + +OliveTin documentation + + + + + + +
    +
    +

    8.1. YAML entity files

    +
    +

    YAML files are the default expected format, so you can use .yml, .yaml, or even .txt - as long as the file contains a valid yaml LIST, then it will be loaded.

    +
    +
    +
    /etc/OliveTin/servers.yaml
    +
    +
     1
+ 2
+ 3
+ 4
+ 5
+ 6
+ 7
+ 8
+ 9
+10
+11
+12
+
    server1:
+  state: started
+  hostname: server1.example.com
+  ip: 192.168.0.1
+server2:
+  state: started
+  hostname: server2.example.com
+  ip: 192.168.0.2
+server3:
+  state: stopped
+  hostname: server3.example.com
+  ip: 192.168.0.3
+
    +
    +
    +
    +
    +

    ↑ Up: Entities | ⌂ Home: OliveTin documentation | Next: JSON entity files →

    +
    +
    + + + \ No newline at end of file diff --git a/action-container-control.html b/action-container-control.html index 6dee872fb..dac5df334 100644 --- a/action-container-control.html +++ b/action-container-control.html @@ -191,13 +191,17 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization
    • -
  • 11. API +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting +
    • +
  • 13. API
    • @@ -308,7 +312,7 @@

    -Last updated 2024-02-21 17:12:29 UTC +Last updated 2024-02-21 17:20:06 UTC

    diff --git a/action-customisation.html b/action-customisation.html index d42b84e51..122e7cf52 100644 --- a/action-customisation.html +++ b/action-customisation.html @@ -187,13 +187,17 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization
    • -
  • 11. API +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting +
    • +
  • 13. API
    • @@ -226,7 +230,7 @@

    diff --git a/action-ping.html b/action-ping.html index 76b915242..d737011fa 100644 --- a/action-ping.html +++ b/action-ping.html @@ -191,13 +191,17 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization
    • -
  • 11. API +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting +
    • +
  • 13. API
    • @@ -247,7 +251,7 @@

    diff --git a/action-service.html b/action-service.html index 21f7ef5ed..8e3564ec7 100644 --- a/action-service.html +++ b/action-service.html @@ -305,13 +305,17 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization
    • -
  • 11. API +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting +
    • +
  • 13. API

    • @@ -368,7 +372,7 @@

    diff --git a/action-ssh.html b/action-ssh.html index 102478a5f..470f0142c 100644 --- a/action-ssh.html +++ b/action-ssh.html @@ -305,13 +305,17 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization
    • -
  • 11. API +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting +
    • +
  • 13. API

    • @@ -515,7 +519,7 @@

    -Last updated 2024-02-21 17:12:29 UTC +Last updated 2024-02-21 17:20:06 UTC
    diff --git a/actions.html b/actions.html index f3f5706e7..88f83cb5a 100644 --- a/actions.html +++ b/actions.html @@ -195,13 +195,17 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization
    • -
  • 11. API +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting +
    • +
  • 13. API
    • @@ -249,7 +253,7 @@

    -Last updated 2024-02-21 17:12:29 UTC +Last updated 2024-02-21 17:20:06 UTC
    diff --git a/after-completion.html b/after-completion.html index 6de6bdb2c..5af22ecad 100644 --- a/after-completion.html +++ b/after-completion.html @@ -309,13 +309,17 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization
    • -
  • 11. API +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting +
    • +
  • 13. API
    • @@ -348,7 +352,7 @@

    diff --git a/ansible-playbook.html b/ansible-playbook.html index b46d55407..07be4098f 100644 --- a/ansible-playbook.html +++ b/ansible-playbook.html @@ -305,13 +305,17 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization
    • -
  • 11. API +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting +
    • +
  • 13. API
    • @@ -367,7 +371,7 @@

    diff --git a/apache-dns.html b/apache-dns.html index 1022c6de1..0539af0e6 100644 --- a/apache-dns.html +++ b/apache-dns.html @@ -309,13 +309,17 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization
    • -
  • 11. API +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting +
    • +
  • 13. API
    • @@ -350,7 +354,7 @@

    diff --git a/api-start-action.html b/api-start-action.html index b366e7001..e47af861f 100644 --- a/api-start-action.html +++ b/api-start-action.html @@ -291,19 +291,23 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization
    • -
  • 11. API +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting +
    • +
  • 13. API
    • @@ -312,7 +316,7 @@

    OliveTin

    -

    11.2. Starting Actions from the API

    +

    13.2. Starting Actions from the API

    There are several variants of this API call available which might be easier for scripts (or humans) to work with!

    @@ -360,7 +364,7 @@

    -

    11.2.1. Request type: Alias

    +

    13.2.1. Request type: Alias

    Used by:

    @@ -379,7 +383,7 @@

    -

    11.2.2. Request type: OliveTin request object

    +

    13.2.2. Request type: OliveTin request object

    Used by:

    @@ -410,7 +414,7 @@

    -

    11.2.3. Response type: Execution UUID

    +

    13.2.3. Response type: Execution UUID

    Used by:

    @@ -426,7 +430,7 @@

    -

    11.2.4. Response type: LogEntry

    +

    13.2.4. Response type: LogEntry

    Used by:

    @@ -442,7 +446,7 @@

    -

    11.2.5. Example API call; Start an action by Alias

    +

    13.2.5. Example API call; Start an action by Alias

    curl
    @@ -465,7 +469,7 @@

    -

    11.2.6. Example API call: Start an action using StartAction

    +

    13.2.6. Example API call: Start an action using StartAction

    curl
    @@ -481,7 +485,7 @@

    -

    11.2.7. Example API call: Start an action using StartAction with arguments

    +

    13.2.7. Example API call: Start an action using StartAction with arguments

    curl
    @@ -496,7 +500,7 @@

    diff --git a/api.html b/api.html index 8a504f89e..349d84acf 100644 --- a/api.html +++ b/api.html @@ -177,19 +177,23 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization
    • -
  • 11. API +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting +
    • +
  • 13. API
    • @@ -198,7 +202,7 @@

    OliveTin

    -

    11. API

    +

    13. API

    diff --git a/args.html b/args.html index 46c38313d..bcc580ced 100644 --- a/args.html +++ b/args.html @@ -187,19 +187,19 @@

    OliveTin

  • 7.5. Confirmation argument
    • -
  • 7.6. Entities +
    • -
  • 7.7. Dashboards +
  • 8. Entities
    • - +
  • 9. Dashboards
    • -
  • 8. Authentication & Authorization +
  • 10. Authentication & Authorization
    • -
  • 9. Reference +
  • 11. Reference
    • -
  • 10. Support & Troubleshooting +
  • 12. Support & Troubleshooting
    • -
  • 11. API +
  • 13. API
    • @@ -225,12 +225,6 @@

    7.

  • Confirmation argument

    • -
  • -

    Entities

    -
    • -
  • -

    Dashboards

    -

    • @@ -241,7 +235,7 @@

    7.

    diff --git a/auth-concepts.html b/auth-concepts.html index 198cc9a72..fa37ef4ec 100644 --- a/auth-concepts.html +++ b/auth-concepts.html @@ -177,28 +177,32 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities +
    • +
  • 9. Dashboards +
    • +
  • 10. Authentication & Authorization
    • -
  • 9. Reference +
  • 11. Reference
    • -
  • 10. Support & Troubleshooting +
  • 12. Support & Troubleshooting
    • -
  • 11. API +
  • 13. API
    • -

    8.1. Concepts

    +

    10.1. Concepts

    OliveTin does not have any built-in code for doing Authentication (ie: entering a username and password), however it can do Authorization (ie: checking permissions of a user who logged in via another system, like single sign on).

    @@ -234,7 +238,7 @@

    -Last updated 2024-02-21 17:12:29 UTC +Last updated 2024-02-21 17:20:06 UTC

    diff --git a/auth.html b/auth.html index 5ebd94f00..92ca30642 100644 --- a/auth.html +++ b/auth.html @@ -177,28 +177,32 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities +
    • +
  • 9. Dashboards +
    • +
  • 10. Authentication & Authorization
    • -
  • 9. Reference +
  • 11. Reference
    • -
  • 10. Support & Troubleshooting +
  • 12. Support & Troubleshooting
    • -
  • 11. API +
  • 13. API
    • -

    8. Authentication & Authorization

    +

    10. Authentication & Authorization

    See concepts for a good overview of how this works in OliveTin.

    @@ -224,7 +228,7 @@

    8.

    diff --git a/caddy-dns.html b/caddy-dns.html index 922b89e77..33a4c3d32 100644 --- a/caddy-dns.html +++ b/caddy-dns.html @@ -309,13 +309,17 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization
    • -
  • 11. API +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting +
    • +
  • 13. API
    • @@ -341,7 +345,7 @@

    diff --git a/caddy-path.html b/caddy-path.html index fab1f9f5b..5cdc38ec5 100644 --- a/caddy-path.html +++ b/caddy-path.html @@ -309,13 +309,17 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization
    • -
  • 11. API +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting +
    • +
  • 13. API

    • @@ -357,7 +361,7 @@

    diff --git a/choose-package.html b/choose-package.html index 1b71d9d47..d0c743ce6 100644 --- a/choose-package.html +++ b/choose-package.html @@ -201,13 +201,17 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization
    • -
  • 11. API +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting +
    • +
  • 13. API

    • @@ -359,7 +363,7 @@

    diff --git a/concurrency.html b/concurrency.html index f0c9f8560..ce5cf8718 100644 --- a/concurrency.html +++ b/concurrency.html @@ -301,13 +301,17 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization
    • -
  • 11. API +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting +
    • +
  • 13. API

    • @@ -358,7 +362,7 @@

    diff --git a/config.html b/config.html index 7abd0269c..6f3f5e888 100644 --- a/config.html +++ b/config.html @@ -301,13 +301,17 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization
    • -
  • 11. API +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting +
    • +
  • 13. API

    • @@ -384,7 +388,7 @@

    -Last updated 2024-02-21 17:12:29 UTC +Last updated 2024-02-21 17:20:06 UTC

    diff --git a/confirmation.html b/confirmation.html index ba8113489..d3f12ed0a 100644 --- a/confirmation.html +++ b/confirmation.html @@ -187,19 +187,19 @@

    OliveTin

  • 7.5. Confirmation argument
    • -
  • 7.6. Entities +
    • -
  • 7.7. Dashboards +
  • 8. Entities
    • - +
  • 9. Dashboards
    • -
  • 8. Authentication & Authorization +
  • 10. Authentication & Authorization
    • -
  • 9. Reference +
  • 11. Reference
    • -
  • 10. Support & Troubleshooting +
  • 12. Support & Troubleshooting
    • -
  • 11. API +
  • 13. API
    • @@ -236,7 +236,7 @@

    diff --git a/container-dnf.html b/container-dnf.html index 22a4837b6..f1cd08977 100644 --- a/container-dnf.html +++ b/container-dnf.html @@ -177,41 +177,45 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards +
    • +
  • 10. Authentication & Authorization +
    • +
  • 11. Reference
    • -
  • 10. Support & Troubleshooting +
  • 12. Support & Troubleshooting
    • -
  • 11. API +
  • 13. API
    • -

    9.5. Installing extra container packages

    +

    11.5. Installing extra container packages

    The official OliveTin container image is based on Fedora Linux. Fedora has shown to offer a great mix of stability and support over two decades. The base container image for OliveTin is relatively lightweight, with not many tools installed by default. This keeps the download size small, but you may want to add additional packages.

    -

    9.5.1. Quickstart - using DNF to install additional packages

    +

    11.5.1. Quickstart - using DNF to install additional packages

    You can of course create your own container image, but this is probably a lot of work for new users, or people who just want a few extra packages/commands. Instead of creating a whole new container image, you can simply run microdnf (the Fodora package manager) to install more commands.

    @@ -250,7 +254,7 @@

    -

    9.5.2. See also

    +

    11.5.2. See also

    @@ -381,7 +385,7 @@

    <

    diff --git a/dashboards.html b/dashboards.html index 9eeb4a149..e88895b98 100644 --- a/dashboards.html +++ b/dashboards.html @@ -176,37 +176,26 @@

    OliveTin

  • 6. Action examples
  • 7. Arguments - -
    • -
  • 8. Authentication & Authorization -
    • -
  • 9. Reference -
    • -
  • 10. Support & Troubleshooting -
    • -
  • 11. API +
  • 13. API
    • -
    -

    7.7. Dashboards

    +
    +

    9. Dashboards

    +

    OliveTin generates a default view of actions which is useful for simple OliveTin use cases - this is always called "Actions" and cannot be renamed. The Actions view also does not support entities, fieldsets or folders.

    @@ -220,14 +209,19 @@

    +
    +
      +
    +
    +
    -

    ← Previous: Entities | ↑ Up: Arguments | ⌂ Home: OliveTin documentation | Next: Authentication & Authorization →

    +

    ← Previous: JSON entity files | ↑ Up: OliveTin documentation | Next: Authentication & Authorization →

    diff --git a/entities-json.html b/entities-json.html new file mode 100644 index 000000000..1c24b6b58 --- /dev/null +++ b/entities-json.html @@ -0,0 +1,225 @@ + + + + + + + + +OliveTin documentation + + + + + +
    +
    +

    8.2. JSON entity files

    +
    +

    JSON files are parsed as if each line is a single JSON object. This can be super helpful for getting a list of containers, for example; docker ps -a --format=json > /etc/OliveTin/containers.json.

    +
    +
    +
    /etc/OliveTin/containers.json
    +
    +
    {"Command":"\"/opt/entrypoint.sh\"","CreatedAt":"2024-02-08 15:27:42 +0000 GMT","ID":"4bafe6f9f956","Image":"fedora","Labels":"?","LocalVolumes":"0","Mounts":"","Names":"media-indexing-container","Networks":"bridge","Ports":"","RunningFor":"13 days ago","Size":"0B","State":"exited","Status":"Exited (128) 13 days ago"}
+{"Command":"\"/opt/entrypoint.sh\"","CreatedAt":"2023-12-17 20:58:03 +0000 GMT","ID":"d25f37c49c35","Image":"fedora","Labels":"?","LocalVolumes":"0","Mounts":"","Names":"media-playback-container","Networks":"bridge","Ports":"","RunningFor":"27 days ago","Size":"0B","State":"exited","Status":"Exited (137) 27 days ago"}
    +
    +
    +
    +
    +

    ← Previous: YAML entity files | ↑ Up: Entities | ⌂ Home: OliveTin documentation | Next: Dashboards →

    +
    +
    + + + \ No newline at end of file diff --git a/entities.html b/entities.html index b5da26623..844fc1502 100644 --- a/entities.html +++ b/entities.html @@ -290,37 +290,32 @@

    OliveTin

  • 6. Action examples
  • 7. Arguments -
    -
    -

    7.6. Entities

    +
    +

    8. Entities

    +

    An entity is something that exists - a "thing", like a VM, or a Container is an entity. OliveTin allows you to then dynamically generate actions based around these entities.

    @@ -349,63 +344,25 @@

    Entity Actions can only be used on Dashboards.

    -
    -

    7.6.1. YAML entity files

    -
    -

    YAML files are the default expected format, so you can use .yml, .yaml, or even .txt - as long as the file contains a valid yaml LIST, then it will be loaded.

    -
    -
    -
    /etc/OliveTin/servers.yaml
    -
    -
     1
- 2
- 3
- 4
- 5
- 6
- 7
- 8
- 9
-10
-11
-12
-
    server1:
-  state: started
-  hostname: server1.example.com
-  ip: 192.168.0.1
-server2:
-  state: started
-  hostname: server2.example.com
-  ip: 192.168.0.2
-server3:
-  state: stopped
-  hostname: server3.example.com
-  ip: 192.168.0.3
-
    -
    -
    -
    -
    -

    7.6.2. JSON entity files

    -
    -

    JSON files are parsed as if each line is a single JSON object. This can be super helpful for getting a list of containers, for example; docker ps -a --format=json > /etc/OliveTin/containers.json.

    -
    -
    -
    /etc/OliveTin/containers.json
    -
    -
    {"Command":"\"/opt/entrypoint.sh\"","CreatedAt":"2024-02-08 15:27:42 +0000 GMT","ID":"4bafe6f9f956","Image":"fedora","Labels":"?","LocalVolumes":"0","Mounts":"","Names":"media-indexing-container","Networks":"bridge","Ports":"","RunningFor":"13 days ago","Size":"0B","State":"exited","Status":"Exited (128) 13 days ago"}
-{"Command":"\"/opt/entrypoint.sh\"","CreatedAt":"2023-12-17 20:58:03 +0000 GMT","ID":"d25f37c49c35","Image":"fedora","Labels":"?","LocalVolumes":"0","Mounts":"","Names":"media-playback-container","Networks":"bridge","Ports":"","RunningFor":"27 days ago","Size":"0B","State":"exited","Status":"Exited (137) 27 days ago"}
    -
    +
    +
    -

    ← Previous: Confirmation argument | ↑ Up: Arguments | ⌂ Home: OliveTin documentation | Next: Dashboards →

    +

    ← Previous: Confirmation argument | ↑ Up: OliveTin documentation | Next: YAML entity files →

    diff --git a/err-fetch-buttons.html b/err-fetch-buttons.html index b6de548d5..3e64d7a78 100644 --- a/err-fetch-buttons.html +++ b/err-fetch-buttons.html @@ -177,36 +177,40 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization +
    • +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting
    • -
  • 11. API +
  • 13. API
    • -

    10.5. Error Getting Buttons

    +

    12.5. Error Getting Buttons

    This is most often caused by not being able to get to /api/ properly - normally due to a bad proxy config, or your network was disconnected.

    @@ -217,7 +221,7 @@

    diff --git a/err-fetch-webui-settings.html b/err-fetch-webui-settings.html index ec7ddfcd5..148558b15 100644 --- a/err-fetch-webui-settings.html +++ b/err-fetch-webui-settings.html @@ -177,36 +177,40 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization +
    • +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting
    • -
  • 11. API +
  • 13. API

    • -

    10.6. Error Fetching WebUI Settings

    +

    12.6. Error Fetching WebUI Settings

    This is a less common issue, but it means that the main web HTML has loaded, but it could not get http://yourserver:1337/webUiSettings.json - most likely because of a 404 (Not Found) or JSON parse issue. You can see the exact reason if your browser as Web Developer Tools - look in the console. Firefox and Chrome both have great web developer tools, that can normally be opened with the F12 key, or from the developer tools menu.

    @@ -223,7 +227,7 @@

    -Last updated 2024-02-21 17:12:29 UTC +Last updated 2024-02-21 17:20:06 UTC

    diff --git a/err-js-modules-not-supported.html b/err-js-modules-not-supported.html index cba4f8eab..85363faf0 100644 --- a/err-js-modules-not-supported.html +++ b/err-js-modules-not-supported.html @@ -177,36 +177,40 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization +
    • +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting
    • -
  • 11. API +
  • 13. API
    • -

    10.7. Error: JS Modules not supported

    +

    12.7. Error: JS Modules not supported

    This is most likely because you are using a very old browser, or have some Javascript disabled.

    @@ -223,7 +227,7 @@

    -Last updated 2024-02-21 17:12:29 UTC +Last updated 2024-02-21 17:20:06 UTC

    diff --git a/examples.html b/examples.html index 610e5bc13..fc2240f05 100644 --- a/examples.html +++ b/examples.html @@ -191,13 +191,17 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization
    • -
  • 11. API +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting +
    • +
  • 13. API
    • @@ -236,7 +240,7 @@

    -Last updated 2024-02-21 17:12:29 UTC +Last updated 2024-02-21 17:20:06 UTC
    diff --git a/exec-cron.html b/exec-cron.html index 6a707ddbe..d658c0186 100644 --- a/exec-cron.html +++ b/exec-cron.html @@ -309,13 +309,17 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization
    • -
  • 11. API +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting +
    • +
  • 13. API
    • @@ -372,7 +376,7 @@

    -Last updated 2024-02-21 17:12:29 UTC +Last updated 2024-02-21 17:20:06 UTC
    diff --git a/exec-file-changed.html b/exec-file-changed.html index 5a57245a7..28b84f6bd 100644 --- a/exec-file-changed.html +++ b/exec-file-changed.html @@ -309,13 +309,17 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization
    • -
  • 11. API +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting +
    • +
  • 13. API
    • @@ -342,7 +346,7 @@

    diff --git a/exec-file-created.html b/exec-file-created.html index e92441184..db4fb31d8 100644 --- a/exec-file-created.html +++ b/exec-file-created.html @@ -309,13 +309,17 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization
    • -
  • 11. API +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting +
    • +
  • 13. API
    • @@ -342,7 +346,7 @@

    diff --git a/exec-on-demand.html b/exec-on-demand.html index 2e5248865..ee0f5979e 100644 --- a/exec-on-demand.html +++ b/exec-on-demand.html @@ -195,13 +195,17 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization
    • -
  • 11. API +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting +
    • +
  • 13. API
    • @@ -219,7 +223,7 @@

    -Last updated 2024-02-21 17:12:29 UTC +Last updated 2024-02-21 17:20:06 UTC
    diff --git a/exec-startup.html b/exec-startup.html index 7c928c3d6..7299fdb22 100644 --- a/exec-startup.html +++ b/exec-startup.html @@ -195,13 +195,17 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization
    • -
  • 11. API +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting +
    • +
  • 13. API
    • @@ -244,7 +248,7 @@

    diff --git a/exec-webhook.html b/exec-webhook.html index da739464d..2058ecf9d 100644 --- a/exec-webhook.html +++ b/exec-webhook.html @@ -195,13 +195,17 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization
    • -
  • 11. API +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting +
    • +
  • 13. API
    • @@ -268,7 +272,7 @@

    diff --git a/haproxy-dns.html b/haproxy-dns.html index 55adbf9ca..ebeb28841 100644 --- a/haproxy-dns.html +++ b/haproxy-dns.html @@ -309,13 +309,17 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization
    • -
  • 11. API +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting +
    • +
  • 13. API
    • @@ -353,7 +357,7 @@

    diff --git a/icons.html b/icons.html index 63a864f72..714e74be8 100644 --- a/icons.html +++ b/icons.html @@ -187,13 +187,17 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization
    • -
  • 11. API +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting +
    • +
  • 13. API
    • @@ -313,7 +317,7 @@

    -Last updated 2024-02-21 17:12:29 UTC +Last updated 2024-02-21 17:20:06 UTC
    diff --git a/index.html b/index.html index 4fa51d96f..766c8a864 100644 --- a/index.html +++ b/index.html @@ -177,13 +177,17 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization
    • -
  • 11. API +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting +
    • +
  • 13. API
    • @@ -306,6 +310,12 @@

    Read more

    Arguments

  • +

    Entities

    +
    • +
  • +

    Dashboards

    +
    • +

  • Authentication & Authorization

  • @@ -325,7 +335,7 @@

    Read more

    diff --git a/install-alpine.html b/install-alpine.html index 442c25e24..b27f79d1f 100644 --- a/install-alpine.html +++ b/install-alpine.html @@ -201,13 +201,17 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization
    • -
  • 11. API +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting +
    • +
  • 13. API
    • @@ -243,7 +247,7 @@

    diff --git a/install-archbtw.html b/install-archbtw.html index 44d90fe6b..691cdf064 100644 --- a/install-archbtw.html +++ b/install-archbtw.html @@ -315,13 +315,17 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization
    • -
  • 11. API +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting +
    • +
  • 13. API
    • @@ -431,7 +435,7 @@

    -Last updated 2024-02-21 17:12:29 UTC +Last updated 2024-02-21 17:20:06 UTC
    diff --git a/install-compose.html b/install-compose.html index 276935005..1724ce38a 100644 --- a/install-compose.html +++ b/install-compose.html @@ -315,13 +315,17 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization
    • -
  • 11. API +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting +
    • +
  • 13. API
    • @@ -496,7 +500,7 @@

    diff --git a/install-container-vs-service.html b/install-container-vs-service.html index 46c71a958..21d2f81f7 100644 --- a/install-container-vs-service.html +++ b/install-container-vs-service.html @@ -201,13 +201,17 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization
    • -
  • 11. API +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting +
    • +
  • 13. API
    • @@ -263,7 +267,7 @@

    diff --git a/install-container.html b/install-container.html index 6e66d2fc8..426239b49 100644 --- a/install-container.html +++ b/install-container.html @@ -315,13 +315,17 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization
    • -
  • 11. API +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting +
    • +
  • 13. API
    • @@ -460,7 +464,7 @@

    -Last updated 2024-02-21 17:12:29 UTC +Last updated 2024-02-21 17:20:06 UTC
    diff --git a/install-fedora.html b/install-fedora.html index dd9be3475..99a750637 100644 --- a/install-fedora.html +++ b/install-fedora.html @@ -315,13 +315,17 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization
    • -
  • 11. API +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting +
    • +
  • 13. API
    • @@ -421,7 +425,7 @@

    -Last updated 2024-02-21 17:12:29 UTC +Last updated 2024-02-21 17:20:06 UTC
    diff --git a/install-helm.html b/install-helm.html index fb8bfab2d..75e8ce913 100644 --- a/install-helm.html +++ b/install-helm.html @@ -201,13 +201,17 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization
    • -
  • 11. API +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting +
    • +
  • 13. API
    • @@ -267,7 +271,7 @@

    < diff --git a/install-k8s.html b/install-k8s.html index baa53e971..50d250dc2 100644 --- a/install-k8s.html +++ b/install-k8s.html @@ -315,13 +315,17 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization
    • -
  • 11. API +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting +
    • +
  • 13. API
    • @@ -385,7 +389,7 @@

    diff --git a/install-linuxpackage.html b/install-linuxpackage.html index 34b6f192c..c33b7e5a7 100644 --- a/install-linuxpackage.html +++ b/install-linuxpackage.html @@ -315,13 +315,17 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization
    • -
  • 11. API +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting +
    • +
  • 13. API
    • @@ -422,7 +426,7 @@

    -Last updated 2024-02-21 17:12:29 UTC +Last updated 2024-02-21 17:20:06 UTC
    diff --git a/install-targz.html b/install-targz.html index c90aa1157..66292dffe 100644 --- a/install-targz.html +++ b/install-targz.html @@ -315,13 +315,17 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization
    • -
  • 11. API +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting +
    • +
  • 13. API
    • @@ -429,7 +433,7 @@

    -Last updated 2024-02-21 17:12:29 UTC +Last updated 2024-02-21 17:20:06 UTC
    diff --git a/installation.html b/installation.html index 3ea10989f..216c3d552 100644 --- a/installation.html +++ b/installation.html @@ -201,13 +201,17 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization
    • -
  • 11. API +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting +
    • +
  • 13. API
    • @@ -281,7 +285,7 @@

    diff --git a/jwt.html b/jwt.html index 0432de725..a30f3b3ea 100644 --- a/jwt.html +++ b/jwt.html @@ -177,28 +177,32 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities +
    • +
  • 9. Dashboards +
    • +
  • 10. Authentication & Authorization
    • -
  • 9. Reference +
  • 11. Reference
    • -
  • 10. Support & Troubleshooting +
  • 12. Support & Troubleshooting
    • -
  • 11. API +
  • 13. API
    • -

    8.3. JWT Authorization

    +

    10.3. JWT Authorization

    You need to know your JWT Cookie Name and Hash Secret. Whatever tool you are using to authenticate users will probably have instructions on how to find this.

    @@ -210,7 +214,7 @@

    8.3.

    -

    8.3.1. Adding JWT details to OliveTin config.yaml

    +

    10.3.1. Adding JWT details to OliveTin config.yaml

    Setup your config file so it has something like this;

    @@ -230,13 +234,13 @@

    -

    8.3.2. Usable claims

    +

    10.3.2. Usable claims

    OliveTin currently can match Access Control Lists based on a username or primary user group. These must be called name and group respectively. You can see if these are being used properly turning on DEBUG logging and looking at the jwt claims.

    -

    8.3.3. Setup default permissions

    +

    10.3.3. Setup default permissions

    OliveTin will assume that guests are able to View and Execute every action by default. When you are setting up authorization you probably want to limit this. You can do that by setting defaultPermissions like this;

    @@ -251,7 +255,7 @@

    -

    8.3.4. Setup OliveTin Access Control Lists

    +

    10.3.4. Setup OliveTin Access Control Lists

    Access Control Lists are a way to override the default permissions.

    @@ -294,7 +298,7 @@

    -

    8.3.5. Customizing field names

    +

    10.3.5. Customizing field names

    You may need to customize the field names for your JWT authentication.

    @@ -312,7 +316,7 @@

    -Last updated 2024-02-21 17:12:29 UTC +Last updated 2024-02-21 17:20:06 UTC

    diff --git a/log-levels.html b/log-levels.html index 56b1a51b0..2220cea82 100644 --- a/log-levels.html +++ b/log-levels.html @@ -301,13 +301,17 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization
    • -
  • 11. API +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting +
    • +
  • 13. API
    • @@ -364,7 +368,7 @@

    diff --git a/multi-inst.html b/multi-inst.html index fef36588b..7df2365d0 100644 --- a/multi-inst.html +++ b/multi-inst.html @@ -177,41 +177,45 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards +
    • +
  • 10. Authentication & Authorization +
    • +
  • 11. Reference
    • -
  • 10. Support & Troubleshooting +
  • 12. Support & Troubleshooting
    • -
  • 11. API +
  • 13. API
    • -

    9.6. Multiple instances on a server

    +

    11.6. Multiple instances on a server

    Several users will find themselves wanting to run multiple instances of OliveTin. Depending on how you’ve setup OliveTin depends on how easy it is to configure that. This page includes instructions for OliveTin installed as a container, and as a package (.tar.gz).

    -

    9.6.1. With Containers

    +

    11.6.1. With Containers

    This is the easiest way to run multiple OliveTin instances. Follow the Container Installation instructions, or similar for Docker Compose, Helm or similar to get started.

    @@ -236,7 +240,7 @@

    -

    9.6.2. Without containers - using a package (.tar.gz)

    +

    11.6.2. Without containers - using a package (.tar.gz)

    If you are not using containers, then it is probably best not to use a .deb/.rpm installation, as those packages can only be installed for one instance.

    @@ -342,7 +346,7 @@

    -Last updated 2024-02-21 17:12:29 UTC +Last updated 2024-02-21 17:20:06 UTC

    diff --git a/network-ports.html b/network-ports.html index 3ba6fd700..c8fa4074d 100644 --- a/network-ports.html +++ b/network-ports.html @@ -177,36 +177,40 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards +
    • +
  • 10. Authentication & Authorization +
    • +
  • 11. Reference
    • -
  • 10. Support & Troubleshooting +
  • 12. Support & Troubleshooting
    • -
  • 11. API +
  • 13. API
    • -

    9.1. Network ports

    +

    11.1. Network ports

    OliveTin might suprise some people when they see it is listening on several ports when it starts up. Most of these ports are internal and localhost-only by @@ -277,7 +281,7 @@

    -

    9.1.1. See also

    +

    11.1.1. See also

    @@ -360,7 +364,7 @@

    diff --git a/nginx-path.html b/nginx-path.html index 92d8b5be6..bded094b4 100644 --- a/nginx-path.html +++ b/nginx-path.html @@ -309,13 +309,17 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization
    • -
  • 11. API +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting +
    • +
  • 13. API

    • @@ -353,7 +357,7 @@

    diff --git a/no-puid-pgid.html b/no-puid-pgid.html index e0c7d4f17..cf81e2ea7 100644 --- a/no-puid-pgid.html +++ b/no-puid-pgid.html @@ -291,36 +291,40 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization +
    • +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting
    • -
  • 11. API +
  • 13. API

    • -

    10.4. PUID and PGID support

    +

    12.4. PUID and PGID support

    The OliveTin container image does not use the PUID and PGID convention to specify which user the container should run as - this is a convention that was popularized by linuxserver.io, because their container images use supervisord. Instead, simply use the --user argument when defining the container, to change the user OliveTin runs as.

    @@ -351,7 +355,7 @@

    diff --git a/ports.html b/ports.html index 323827b40..168b21c79 100644 --- a/ports.html +++ b/ports.html @@ -187,13 +187,17 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization
    • -
  • 11. API +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting +
    • +
  • 13. API

    • @@ -211,7 +215,7 @@

    diff --git a/powershell.html b/powershell.html index d034e20a7..4923698f2 100644 --- a/powershell.html +++ b/powershell.html @@ -191,13 +191,17 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization
    • -
  • 11. API +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting +
    • +
  • 13. API

    • @@ -247,7 +251,7 @@

    diff --git a/proxy-guide.html b/proxy-guide.html index d7fb48c4c..7f9013c3b 100644 --- a/proxy-guide.html +++ b/proxy-guide.html @@ -195,13 +195,17 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization
    • -
  • 11. API +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting +
    • +
  • 13. API
    • @@ -273,7 +277,7 @@

    diff --git a/reverse-proxies.html b/reverse-proxies.html index faf1d21f6..43b684bb9 100644 --- a/reverse-proxies.html +++ b/reverse-proxies.html @@ -195,13 +195,17 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization
    • -
  • 11. API +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting +
    • +
  • 13. API
    • @@ -252,7 +256,7 @@

    diff --git a/snapsnots.html b/snapsnots.html index 894227c11..2090af787 100644 --- a/snapsnots.html +++ b/snapsnots.html @@ -177,36 +177,40 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards +
    • +
  • 10. Authentication & Authorization +
    • +
  • 11. Reference
    • -
  • 10. Support & Troubleshooting +
  • 12. Support & Troubleshooting
    • -
  • 11. API +
  • 13. API
    • -

    9.7. Snapshot builds

    +

    11.7. Snapshot builds

    It’s sometimes useful to test code changes in OliveTin that are still in development - and have not yet made it into an official version, yet. Thankfully, all code changes are automatically compiled into a "snapshot" builds and are saved in GitHub actions.

    @@ -229,7 +233,7 @@

    Most of the time you will want to select the top build, unless you’ve specifically been given a build link to use.

    -

    9.7.1. Download the snapshot archive

    +

    11.7.1. Download the snapshot archive

    On the job page, you will have a single "snapshot" file listed. In this screenshot, it is 109 MB.

    @@ -257,7 +261,7 @@

    -Last updated 2024-02-21 17:12:29 UTC +Last updated 2024-02-21 17:20:06 UTC

    diff --git a/sosreport.html b/sosreport.html index 49d23675b..64e6caa5f 100644 --- a/sosreport.html +++ b/sosreport.html @@ -177,36 +177,40 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization +
    • +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting
    • -
  • 11. API +
  • 13. API
    • -

    10.2. sosreport

    +

    12.2. sosreport

    OliveTin has a useful feature to gather information about your installation that is useful when you’re asking for help - when you have a support request. If you are able to provide sosreport, this generally helps others help you a lot. The sosreport feature does NOT send any information to the developers or anybody else, it’s simply text - copy and paste it to where someone is trying to help you!

    @@ -239,7 +243,7 @@

    You can then copy and paste this text into a GitHub issue, discussion, Discord chat, or wherever else someone might be helping you.

    -

    10.2.1. How do I generate a sosreport?

    +

    12.2.1. How do I generate a sosreport?

    OliveTin needs to be able to startup and it’s API needs to be functional. Once OliveTin is started, simply browse to: http://myserver:1337/api/sosreport

    @@ -259,7 +263,7 @@

    -

    10.2.2. What if I cannot even get to the OliveTin API?

    +

    12.2.2. What if I cannot even get to the OliveTin API?

    OliveTin’s web interface doesn’t need to be working to get a sosreport (as the web interface and the API are separate). However, if OliveTin won’t even startup, or you cannot seem to get to the API, then sadly a sosreport can’t help you. Please do specify that when you ask for help.

    @@ -271,7 +275,7 @@

    -Last updated 2024-02-21 17:12:29 UTC +Last updated 2024-02-21 17:20:06 UTC

    diff --git a/support.html b/support.html index 5800518d2..dd3846a5e 100644 --- a/support.html +++ b/support.html @@ -177,36 +177,40 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization +
    • +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting
    • -
  • 11. API +
  • 13. API
    • -

    10.1. Where to find help

    +

    12.1. Where to find help

    Please feel free to open a support request issue on GitHub to ask for help with troubleshooting, or come and chat with us.

    @@ -224,7 +228,7 @@

    -Last updated 2024-02-21 17:12:29 UTC +Last updated 2024-02-21 17:20:06 UTC

    diff --git a/timeout.html b/timeout.html index 76cb5b696..612d22dab 100644 --- a/timeout.html +++ b/timeout.html @@ -187,13 +187,17 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization
    • -
  • 11. API +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting +
    • +
  • 13. API
    • @@ -248,7 +252,7 @@

    diff --git a/timezone.html b/timezone.html index 2f5d08967..34040c056 100644 --- a/timezone.html +++ b/timezone.html @@ -187,13 +187,17 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization
    • -
  • 11. API +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting +
    • +
  • 13. API

    • @@ -229,7 +233,7 @@

    -Last updated 2024-02-21 17:12:29 UTC +Last updated 2024-02-21 17:20:06 UTC
    diff --git a/toggle-webui.html b/toggle-webui.html index 90dfdfc31..ad3b60b71 100644 --- a/toggle-webui.html +++ b/toggle-webui.html @@ -301,13 +301,17 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization
    • -
  • 11. API +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting +
    • +
  • 13. API
    • @@ -388,7 +392,7 @@

    diff --git a/troubleshooting.html b/troubleshooting.html index fefe0e6bd..6d0debb38 100644 --- a/troubleshooting.html +++ b/troubleshooting.html @@ -177,36 +177,40 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards
    • -
  • 10. Support & Troubleshooting +
  • 10. Authentication & Authorization +
    • +
  • 11. Reference +
    • +
  • 12. Support & Troubleshooting
    • -
  • 11. API +
  • 13. API
    • -

    10. Support & Troubleshooting

    +

    12. Support & Troubleshooting

    -

    8.2. Trusted Header Authorization

    +

    10.2. Trusted Header Authorization

    This method is not yet well documented, sorry! Ask on Discord - we need more people to test this feature.

    @@ -227,7 +231,7 @@

    -Last updated 2024-02-21 17:12:29 UTC +Last updated 2024-02-21 17:20:06 UTC

    diff --git a/update-tracking.html b/update-tracking.html index 26cdcb08a..c643dc5bf 100644 --- a/update-tracking.html +++ b/update-tracking.html @@ -177,36 +177,40 @@

    OliveTin

  • 7. Arguments
    • -
  • 8. Authentication & Authorization +
  • 8. Entities
    • -
  • 9. Reference +
  • 9. Dashboards +
    • +
  • 10. Authentication & Authorization +
    • +
  • 11. Reference
    • -
  • 10. Support & Troubleshooting +
  • 12. Support & Troubleshooting
    • -
  • 11. API +
  • 13. API
    • -

    9.4. Update Checks (and tracking)

    +

    11.4. Update Checks (and tracking)

    The OliveTin server will now check for updates on startup, and every 7 days after that. It will report those updates as a log message in the console. It does not apply any updates, because this is the choice and responsibility of whoever is running OliveTin to decide if, when, and how to apply any updates.

    @@ -214,7 +218,7 @@

    The information OliveTin sends to the update server is stored/saved., and this could be considered a form of tracking - that is tracking installations, not tracking people. This page hopefully helps explain what, how and why that information is used so you can be informed (and make changes if you wish).

    -

    9.4.1. Design considerations

    +

    11.4.1. Design considerations

    • @@ -239,7 +243,7 @@

    -

    9.4.2. What is sent (and tracked)

    +

    11.4.2. What is sent (and tracked)

    When OliveTin checks for updates, it will send the following;

    @@ -275,7 +279,7 @@

    -

    9.4.3. What is the OliveTin installation ID?

    +

    11.4.3. What is the OliveTin installation ID?

    This is a randomly generated UUID - that is not based on your operating system, not on any of your data. OliveTin tries to create a random installation-id.txt in your config directory when it starts up.

    @@ -287,7 +291,7 @@

    -

    9.4.4. Why do you need my machine ID?

    +

    11.4.4. Why do you need my machine ID?

    This was changed in OliveTin - the MachineID is no longer collected, and the project moved to InstallationID instead. The answer is kept here for old versions.

    @@ -306,7 +310,7 @@

    -

    9.4.5. Why do you need to store any information at all?

    +

    11.4.5. Why do you need to store any information at all?

    This is incredibly useful information for project developers to know, because;

    @@ -325,7 +329,7 @@

    -

    9.4.6. What is stored?

    +

    11.4.6. What is stored?

    The update service only stores the information that is sent - explained with an example above.

    @@ -334,7 +338,7 @@

    -

    9.4.7. What is not sent/stored

    +

    11.4.7. What is not sent/stored

    -

    9.4.9. Why isn’t this opt-in?

    +

    11.4.9. Why isn’t this opt-in?

    It seems the majority of software does perform update checks by default like this - Chrome, Firefox, most modern Operating Systems, etc. Because no information about people, or your data is being used, apart from your installation ID, this seems like a safe default.

    @@ -365,7 +369,7 @@

    <

    -

    9.4.10. How do I disable update checking?

    +

    11.4.10. How do I disable update checking?

    If you are worried about privacy, or similar, please do make your concerns known. This is best if this is an open discussion.

    @@ -379,7 +383,7 @@

    <

    -

    9.4.11. How can I hide version upgrades in the OliveTin web interface?

    +

    11.4.11. How can I hide version upgrades in the OliveTin web interface?

    Set the following in your configuration file;

    @@ -393,7 +397,7 @@

    -

    9.4.12. Why can’t I visit update-check.olivetin.app in my browser?

    +

    11.4.12. Why can’t I visit update-check.olivetin.app in my browser?

    The root domain for OliveTin (OliveTin.app) has HSTS turned on - this forces your browser to use SSL (HTTPS - the little encryption padlock) for all subdomains - including www.olivetin.app and docs.olivetin.app. Although both of those websites don’t transmit anything that really needs encrypion, the web is certainly moving to having SSL turned on everywhere. It even has a positive impact on search engine rankings!

    @@ -414,7 +418,7 @@

    9.