diff --git a/_dropdown_choice_arguments.html b/_dropdown_choice_arguments.html index 513cb91e9..2bd172617 100644 --- a/_dropdown_choice_arguments.html +++ b/_dropdown_choice_arguments.html @@ -195,11 +195,13 @@

OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API
    • @@ -252,7 +254,7 @@

    -Last updated 2024-02-21 17:20:06 UTC +Last updated 2024-02-21 17:25:02 UTC
    diff --git a/_exit_code_127.html b/_exit_code_127.html index fa423d837..b20f3ca51 100644 --- a/_exit_code_127.html +++ b/_exit_code_127.html @@ -183,34 +183,36 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference +
    • +
  • 13. Support & Troubleshooting
    • -
  • 13. API +
  • 14. API
    • -

    12.3. Exit code 127

    +

    13.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.

    @@ -222,7 +224,7 @@

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

    diff --git a/_gpio_control_on_raspberry_pi.html b/_gpio_control_on_raspberry_pi.html new file mode 100644 index 000000000..86b3a371a --- /dev/null +++ b/_gpio_control_on_raspberry_pi.html @@ -0,0 +1,220 @@ + + + + + + + + +OliveTin documentation + + + + + +
    +
    +

    11.2. GPIO Control on Raspberry Pi

    +
    +

    TODO :-)

    +
    +
    +
    +

    ← Previous: Homelab Container Control Panel (Traefik, Docker) | ↑ Up: Solutions | ⌂ Home: OliveTin documentation | Next: Reference →

    +
    +
    + + + \ No newline at end of file diff --git a/_homelab_container_control_panel_traefik_docker.html b/_homelab_container_control_panel_traefik_docker.html new file mode 100644 index 000000000..b604f9764 --- /dev/null +++ b/_homelab_container_control_panel_traefik_docker.html @@ -0,0 +1,220 @@ + + + + + + + + +OliveTin documentation + + + + + +
    +
    +

    11.1. Homelab Container Control Panel (Traefik, Docker)

    +
    +

    TODO :-)

    +
    +
    +
    +

    ↑ Up: Solutions | ⌂ Home: OliveTin documentation | Next: GPIO Control on Raspberry Pi →

    +
    +
    + + + \ No newline at end of file diff --git a/_important_safety_warning.html b/_important_safety_warning.html index fde5afecf..1c3893087 100644 --- a/_important_safety_warning.html +++ b/_important_safety_warning.html @@ -195,11 +195,13 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API
    • @@ -233,7 +235,7 @@

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

    diff --git a/_introduction_to_arguments.html b/_introduction_to_arguments.html index c6c11ffc4..ecaaf6ac4 100644 --- a/_introduction_to_arguments.html +++ b/_introduction_to_arguments.html @@ -195,11 +195,13 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API
    • @@ -236,7 +238,7 @@

    -Last updated 2024-02-21 17:20:06 UTC +Last updated 2024-02-21 17:25:02 UTC
    diff --git a/_misc_api_calls.html b/_misc_api_calls.html index 77f094ed3..b365b3bbe 100644 --- a/_misc_api_calls.html +++ b/_misc_api_calls.html @@ -183,17 +183,19 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API
    • @@ -202,9 +204,9 @@

    OliveTin

    -

    13.3. Misc API calls

    +

    14.3. Misc API calls

    -

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

    +

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

    curl
    @@ -219,7 +221,7 @@

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

    diff --git a/_olivetin_api_overview.html b/_olivetin_api_overview.html index 0ff91c310..8db0bf748 100644 --- a/_olivetin_api_overview.html +++ b/_olivetin_api_overview.html @@ -183,17 +183,19 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API
    • @@ -202,7 +204,7 @@

    OliveTin

    -

    13.1. OliveTin API Overview

    +

    14.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.

    @@ -219,7 +221,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.

    -

    13.1.1. Links

    +

    14.1.1. Links

    diff --git a/_reference.html b/_reference.html index 2009fb00e..ed7ca591c 100644 --- a/_reference.html +++ b/_reference.html @@ -183,34 +183,36 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions +
    • +
  • 12. Reference
    • -
  • 12. Support & Troubleshooting +
  • 13. Support & Troubleshooting
    • -
  • 13. API +
  • 14. API
    • -

    11. Reference

    +

    12. Reference

      @@ -240,12 +242,12 @@

    -

    ← Previous: JWT Authorization | ↑ Up: OliveTin documentation | Next: Network ports →

    +

    ← Previous: GPIO Control on Raspberry Pi | ↑ Up: OliveTin documentation | Next: Network ports →

    diff --git a/_run_as_different_users.html b/_run_as_different_users.html index 24a0fa45c..8cdd5e5fb 100644 --- a/_run_as_different_users.html +++ b/_run_as_different_users.html @@ -193,11 +193,13 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API
    • @@ -242,7 +244,7 @@

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

    diff --git a/_security.html b/_security.html index b43ecd442..30cb102e4 100644 --- a/_security.html +++ b/_security.html @@ -183,34 +183,36 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions +
    • +
  • 12. Reference
    • -
  • 12. Support & Troubleshooting +
  • 13. Support & Troubleshooting
    • -
  • 13. API +
  • 14. API
    • -

    11.2. Security

    +

    12.2. Security

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

    @@ -244,7 +246,7 @@

    diff --git a/_textbox_arguments.html b/_textbox_arguments.html index 0fbbbe410..5509c9c89 100644 --- a/_textbox_arguments.html +++ b/_textbox_arguments.html @@ -195,11 +195,13 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API

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

    diff --git a/_understanding_exit_codes.html b/_understanding_exit_codes.html index 927c564a1..ad86d57ad 100644 --- a/_understanding_exit_codes.html +++ b/_understanding_exit_codes.html @@ -183,34 +183,36 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions +
    • +
  • 12. Reference
    • -
  • 12. Support & Troubleshooting +
  • 13. Support & Troubleshooting
    • -
  • 13. API +
  • 14. API

    • -

    11.3. Understanding exit codes

    +

    12.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 @@ -228,7 +230,7 @@

    -

    11.3.1. Common error codes

    +

    12.3.1. Common error codes

    • @@ -244,7 +246,7 @@

      <

    diff --git a/_yaml_entity_files.html b/_yaml_entity_files.html index 9dc5aba65..50e04ae32 100644 --- a/_yaml_entity_files.html +++ b/_yaml_entity_files.html @@ -303,11 +303,13 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API
    • @@ -355,7 +357,7 @@

    diff --git a/action-container-control.html b/action-container-control.html index dac5df334..82aa30ba6 100644 --- a/action-container-control.html +++ b/action-container-control.html @@ -197,11 +197,13 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API

    • @@ -312,7 +314,7 @@

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

    diff --git a/action-customisation.html b/action-customisation.html index 122e7cf52..81acde4bb 100644 --- a/action-customisation.html +++ b/action-customisation.html @@ -193,11 +193,13 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API
    • @@ -230,7 +232,7 @@

    diff --git a/action-ping.html b/action-ping.html index d737011fa..2c9d2d6a0 100644 --- a/action-ping.html +++ b/action-ping.html @@ -197,11 +197,13 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API
    • @@ -251,7 +253,7 @@

    diff --git a/action-service.html b/action-service.html index 8e3564ec7..0d4933afc 100644 --- a/action-service.html +++ b/action-service.html @@ -311,11 +311,13 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API
    • @@ -372,7 +374,7 @@

    diff --git a/action-ssh.html b/action-ssh.html index 470f0142c..660fe78b3 100644 --- a/action-ssh.html +++ b/action-ssh.html @@ -311,11 +311,13 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API
    • @@ -519,7 +521,7 @@

    -Last updated 2024-02-21 17:20:06 UTC +Last updated 2024-02-21 17:25:02 UTC
    diff --git a/actions.html b/actions.html index 88f83cb5a..a8e39cc31 100644 --- a/actions.html +++ b/actions.html @@ -201,11 +201,13 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API
    • @@ -253,7 +255,7 @@

    -Last updated 2024-02-21 17:20:06 UTC +Last updated 2024-02-21 17:25:02 UTC
    diff --git a/after-completion.html b/after-completion.html index 5af22ecad..ee0a00fa0 100644 --- a/after-completion.html +++ b/after-completion.html @@ -315,11 +315,13 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API
    • @@ -352,7 +354,7 @@

    diff --git a/ansible-playbook.html b/ansible-playbook.html index 07be4098f..8275da3d7 100644 --- a/ansible-playbook.html +++ b/ansible-playbook.html @@ -311,11 +311,13 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API
    • @@ -371,7 +373,7 @@

    diff --git a/apache-dns.html b/apache-dns.html index 0539af0e6..a7d3b8587 100644 --- a/apache-dns.html +++ b/apache-dns.html @@ -315,11 +315,13 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API
    • @@ -354,7 +356,7 @@

    diff --git a/api-start-action.html b/api-start-action.html index e47af861f..971e45eda 100644 --- a/api-start-action.html +++ b/api-start-action.html @@ -297,17 +297,19 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API
    • @@ -316,7 +318,7 @@

    OliveTin

    -

    13.2. Starting Actions from the API

    +

    14.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!

    @@ -364,7 +366,7 @@

    -

    13.2.1. Request type: Alias

    +

    14.2.1. Request type: Alias

    Used by:

    @@ -383,7 +385,7 @@

    -

    13.2.2. Request type: OliveTin request object

    +

    14.2.2. Request type: OliveTin request object

    Used by:

    @@ -414,7 +416,7 @@

    -

    13.2.3. Response type: Execution UUID

    +

    14.2.3. Response type: Execution UUID

    Used by:

    @@ -430,7 +432,7 @@

    -

    13.2.4. Response type: LogEntry

    +

    14.2.4. Response type: LogEntry

    Used by:

    @@ -446,7 +448,7 @@

    -

    13.2.5. Example API call; Start an action by Alias

    +

    14.2.5. Example API call; Start an action by Alias

    curl
    @@ -469,7 +471,7 @@

    -

    13.2.6. Example API call: Start an action using StartAction

    +

    14.2.6. Example API call: Start an action using StartAction

    curl
    @@ -485,7 +487,7 @@

    -

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

    +

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

    curl
    @@ -500,7 +502,7 @@

    diff --git a/api.html b/api.html index 349d84acf..e8215ae4b 100644 --- a/api.html +++ b/api.html @@ -183,17 +183,19 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API
    • @@ -202,7 +204,7 @@

    OliveTin

    -

    13. API

    +

    14. API

    diff --git a/args.html b/args.html index bcc580ced..e89594cdc 100644 --- a/args.html +++ b/args.html @@ -195,11 +195,13 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API
    • @@ -235,7 +237,7 @@

    7.

    diff --git a/auth-concepts.html b/auth-concepts.html index fa37ef4ec..ce716ca09 100644 --- a/auth-concepts.html +++ b/auth-concepts.html @@ -191,11 +191,13 @@

    OliveTin

    -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API
    • @@ -238,7 +240,7 @@

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

    diff --git a/auth.html b/auth.html index 92ca30642..c85a64af7 100644 --- a/auth.html +++ b/auth.html @@ -191,11 +191,13 @@

    OliveTin

    -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API
    • @@ -228,7 +230,7 @@

    10

    diff --git a/caddy-dns.html b/caddy-dns.html index 33a4c3d32..fd395b8d0 100644 --- a/caddy-dns.html +++ b/caddy-dns.html @@ -315,11 +315,13 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API
    • @@ -345,7 +347,7 @@

    diff --git a/caddy-path.html b/caddy-path.html index 5cdc38ec5..499d80590 100644 --- a/caddy-path.html +++ b/caddy-path.html @@ -315,11 +315,13 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API

    • @@ -361,7 +363,7 @@

    diff --git a/choose-package.html b/choose-package.html index d0c743ce6..dfa2dd0a6 100644 --- a/choose-package.html +++ b/choose-package.html @@ -207,11 +207,13 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API

    • @@ -363,7 +365,7 @@

    diff --git a/concurrency.html b/concurrency.html index ce5cf8718..ae2a6206f 100644 --- a/concurrency.html +++ b/concurrency.html @@ -307,11 +307,13 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API

    • @@ -362,7 +364,7 @@

    diff --git a/config.html b/config.html index 6f3f5e888..8a3fc3416 100644 --- a/config.html +++ b/config.html @@ -307,11 +307,13 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API

    • @@ -388,7 +390,7 @@

    -Last updated 2024-02-21 17:20:06 UTC +Last updated 2024-02-21 17:25:02 UTC
    diff --git a/confirmation.html b/confirmation.html index d3f12ed0a..8f0016125 100644 --- a/confirmation.html +++ b/confirmation.html @@ -195,11 +195,13 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API
    • @@ -236,7 +238,7 @@

    diff --git a/container-dnf.html b/container-dnf.html index f1cd08977..7de8e9706 100644 --- a/container-dnf.html +++ b/container-dnf.html @@ -183,39 +183,41 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions +
    • +
  • 12. Reference
    • -
  • 12. Support & Troubleshooting +
  • 13. Support & Troubleshooting
    • -
  • 13. API +
  • 14. API
    • -

    11.5. Installing extra container packages

    +

    12.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.

    -

    11.5.1. Quickstart - using DNF to install additional packages

    +

    12.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.

    @@ -254,7 +256,7 @@

    -

    11.5.2. See also

    +

    12.5.2. See also

    @@ -385,7 +387,7 @@

    <

    diff --git a/dashboards.html b/dashboards.html index e88895b98..78093ad05 100644 --- a/dashboards.html +++ b/dashboards.html @@ -183,11 +183,13 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API
    • @@ -221,7 +223,7 @@

    diff --git a/entities-json.html b/entities-json.html index 1c24b6b58..1a15e068b 100644 --- a/entities-json.html +++ b/entities-json.html @@ -189,11 +189,13 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API

    • @@ -218,7 +220,7 @@

    -Last updated 2024-02-21 17:20:06 UTC +Last updated 2024-02-21 17:25:02 UTC
    diff --git a/entities.html b/entities.html index 844fc1502..5792749b8 100644 --- a/entities.html +++ b/entities.html @@ -303,11 +303,13 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API
    • @@ -362,7 +364,7 @@

    -Last updated 2024-02-21 17:20:06 UTC +Last updated 2024-02-21 17:25:02 UTC
    diff --git a/err-fetch-buttons.html b/err-fetch-buttons.html index 3e64d7a78..f0f46901c 100644 --- a/err-fetch-buttons.html +++ b/err-fetch-buttons.html @@ -183,34 +183,36 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference +
    • +
  • 13. Support & Troubleshooting
    • -
  • 13. API +
  • 14. API
    • -

    12.5. Error Getting Buttons

    +

    13.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.

    @@ -221,7 +223,7 @@

    diff --git a/err-fetch-webui-settings.html b/err-fetch-webui-settings.html index 148558b15..f4434d283 100644 --- a/err-fetch-webui-settings.html +++ b/err-fetch-webui-settings.html @@ -183,34 +183,36 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference +
    • +
  • 13. Support & Troubleshooting
    • -
  • 13. API +
  • 14. API

    • -

    12.6. Error Fetching WebUI Settings

    +

    13.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.

    @@ -227,7 +229,7 @@

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

    diff --git a/err-js-modules-not-supported.html b/err-js-modules-not-supported.html index 85363faf0..c78f1d347 100644 --- a/err-js-modules-not-supported.html +++ b/err-js-modules-not-supported.html @@ -183,34 +183,36 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference +
    • +
  • 13. Support & Troubleshooting
    • -
  • 13. API +
  • 14. API
    • -

    12.7. Error: JS Modules not supported

    +

    13.7. Error: JS Modules not supported

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

    @@ -227,7 +229,7 @@

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

    diff --git a/examples.html b/examples.html index fc2240f05..6d36e482b 100644 --- a/examples.html +++ b/examples.html @@ -197,11 +197,13 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API
    • @@ -240,7 +242,7 @@

    -Last updated 2024-02-21 17:20:06 UTC +Last updated 2024-02-21 17:25:02 UTC
    diff --git a/exec-cron.html b/exec-cron.html index d658c0186..1086403a2 100644 --- a/exec-cron.html +++ b/exec-cron.html @@ -315,11 +315,13 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API
    • @@ -376,7 +378,7 @@

    -Last updated 2024-02-21 17:20:06 UTC +Last updated 2024-02-21 17:25:02 UTC
    diff --git a/exec-file-changed.html b/exec-file-changed.html index 28b84f6bd..e02b3d6c0 100644 --- a/exec-file-changed.html +++ b/exec-file-changed.html @@ -315,11 +315,13 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API
    • @@ -346,7 +348,7 @@

    diff --git a/exec-file-created.html b/exec-file-created.html index db4fb31d8..6b6c6f0f7 100644 --- a/exec-file-created.html +++ b/exec-file-created.html @@ -315,11 +315,13 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API
    • @@ -346,7 +348,7 @@

    diff --git a/exec-on-demand.html b/exec-on-demand.html index ee0f5979e..590f3ea21 100644 --- a/exec-on-demand.html +++ b/exec-on-demand.html @@ -201,11 +201,13 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API
    • @@ -223,7 +225,7 @@

    -Last updated 2024-02-21 17:20:06 UTC +Last updated 2024-02-21 17:25:02 UTC
    diff --git a/exec-startup.html b/exec-startup.html index 7299fdb22..df19bc6de 100644 --- a/exec-startup.html +++ b/exec-startup.html @@ -201,11 +201,13 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API
    • @@ -248,7 +250,7 @@

    diff --git a/exec-webhook.html b/exec-webhook.html index 2058ecf9d..f224a2d27 100644 --- a/exec-webhook.html +++ b/exec-webhook.html @@ -201,11 +201,13 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API
    • @@ -272,7 +274,7 @@

    diff --git a/haproxy-dns.html b/haproxy-dns.html index ebeb28841..2fa7631c9 100644 --- a/haproxy-dns.html +++ b/haproxy-dns.html @@ -315,11 +315,13 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API
    • @@ -357,7 +359,7 @@

    diff --git a/icons.html b/icons.html index 714e74be8..909924a98 100644 --- a/icons.html +++ b/icons.html @@ -193,11 +193,13 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API
    • @@ -317,7 +319,7 @@

    -Last updated 2024-02-21 17:20:06 UTC +Last updated 2024-02-21 17:25:02 UTC
    diff --git a/index.html b/index.html index 766c8a864..19ca5ceb0 100644 --- a/index.html +++ b/index.html @@ -183,11 +183,13 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API
    • @@ -319,6 +321,9 @@

    Read more

    Authentication & Authorization

  • +

    Solutions

    +
    • +

  • Reference

  • @@ -335,7 +340,7 @@

    Read more

    diff --git a/install-alpine.html b/install-alpine.html index b27f79d1f..85667a84e 100644 --- a/install-alpine.html +++ b/install-alpine.html @@ -207,11 +207,13 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API
    • @@ -247,7 +249,7 @@

    diff --git a/install-archbtw.html b/install-archbtw.html index 691cdf064..cc524a7b5 100644 --- a/install-archbtw.html +++ b/install-archbtw.html @@ -321,11 +321,13 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API
    • @@ -435,7 +437,7 @@

    -Last updated 2024-02-21 17:20:06 UTC +Last updated 2024-02-21 17:25:02 UTC
    diff --git a/install-compose.html b/install-compose.html index 1724ce38a..366e0f081 100644 --- a/install-compose.html +++ b/install-compose.html @@ -321,11 +321,13 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API
    • @@ -500,7 +502,7 @@

    diff --git a/install-container-vs-service.html b/install-container-vs-service.html index 21d2f81f7..91e7025a1 100644 --- a/install-container-vs-service.html +++ b/install-container-vs-service.html @@ -207,11 +207,13 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API
    • @@ -267,7 +269,7 @@

    diff --git a/install-container.html b/install-container.html index 426239b49..91df66422 100644 --- a/install-container.html +++ b/install-container.html @@ -321,11 +321,13 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API
    • @@ -464,7 +466,7 @@

    -Last updated 2024-02-21 17:20:06 UTC +Last updated 2024-02-21 17:25:02 UTC
    diff --git a/install-fedora.html b/install-fedora.html index 99a750637..8efcda997 100644 --- a/install-fedora.html +++ b/install-fedora.html @@ -321,11 +321,13 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API
    • @@ -425,7 +427,7 @@

    -Last updated 2024-02-21 17:20:06 UTC +Last updated 2024-02-21 17:25:02 UTC
    diff --git a/install-helm.html b/install-helm.html index 75e8ce913..d721c1d90 100644 --- a/install-helm.html +++ b/install-helm.html @@ -207,11 +207,13 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API
    • @@ -271,7 +273,7 @@

    < diff --git a/install-k8s.html b/install-k8s.html index 50d250dc2..307659ea9 100644 --- a/install-k8s.html +++ b/install-k8s.html @@ -321,11 +321,13 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API
    • @@ -389,7 +391,7 @@

    diff --git a/install-linuxpackage.html b/install-linuxpackage.html index c33b7e5a7..c53b84a19 100644 --- a/install-linuxpackage.html +++ b/install-linuxpackage.html @@ -321,11 +321,13 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API
    • @@ -426,7 +428,7 @@

    -Last updated 2024-02-21 17:20:06 UTC +Last updated 2024-02-21 17:25:02 UTC
    diff --git a/install-targz.html b/install-targz.html index 66292dffe..75362ef72 100644 --- a/install-targz.html +++ b/install-targz.html @@ -321,11 +321,13 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API
    • @@ -433,7 +435,7 @@

    -Last updated 2024-02-21 17:20:06 UTC +Last updated 2024-02-21 17:25:02 UTC
    diff --git a/installation.html b/installation.html index 216c3d552..5486e9d97 100644 --- a/installation.html +++ b/installation.html @@ -207,11 +207,13 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API
    • @@ -285,7 +287,7 @@

    diff --git a/jwt.html b/jwt.html index a30f3b3ea..3a189607a 100644 --- a/jwt.html +++ b/jwt.html @@ -191,11 +191,13 @@

    OliveTin

    -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API
    • @@ -311,12 +313,12 @@

    -

    ← Previous: Trusted Header Authorization | ↑ Up: Authentication & Authorization | ⌂ Home: OliveTin documentation | Next: Reference →

    +

    ← Previous: Trusted Header Authorization | ↑ Up: Authentication & Authorization | ⌂ Home: OliveTin documentation | Next: Solutions →

    diff --git a/log-levels.html b/log-levels.html index 2220cea82..9ac8e1260 100644 --- a/log-levels.html +++ b/log-levels.html @@ -307,11 +307,13 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API
    • @@ -368,7 +370,7 @@

    diff --git a/multi-inst.html b/multi-inst.html index 7df2365d0..b3279c139 100644 --- a/multi-inst.html +++ b/multi-inst.html @@ -183,39 +183,41 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions +
    • +
  • 12. Reference
    • -
  • 12. Support & Troubleshooting +
  • 13. Support & Troubleshooting
    • -
  • 13. API +
  • 14. API
    • -

    11.6. Multiple instances on a server

    +

    12.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).

    -

    11.6.1. With Containers

    +

    12.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.

    @@ -240,7 +242,7 @@

    -

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

    +

    12.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.

    @@ -346,7 +348,7 @@

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

    diff --git a/network-ports.html b/network-ports.html index c8fa4074d..6ce505d81 100644 --- a/network-ports.html +++ b/network-ports.html @@ -183,34 +183,36 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions +
    • +
  • 12. Reference
    • -
  • 12. Support & Troubleshooting +
  • 13. Support & Troubleshooting
    • -
  • 13. API +
  • 14. API
    • -

    11.1. Network ports

    +

    12.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 @@ -281,7 +283,7 @@

    -

    11.1.1. See also

    +

    12.1.1. See also

    @@ -364,7 +366,7 @@

    diff --git a/nginx-path.html b/nginx-path.html index bded094b4..cf671f368 100644 --- a/nginx-path.html +++ b/nginx-path.html @@ -315,11 +315,13 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API

    • @@ -357,7 +359,7 @@

    diff --git a/no-puid-pgid.html b/no-puid-pgid.html index cf81e2ea7..1588046b8 100644 --- a/no-puid-pgid.html +++ b/no-puid-pgid.html @@ -297,34 +297,36 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference +
    • +
  • 13. Support & Troubleshooting
    • -
  • 13. API +
  • 14. API

    • -

    12.4. PUID and PGID support

    +

    13.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.

    @@ -355,7 +357,7 @@

    diff --git a/ports.html b/ports.html index 168b21c79..40ab9047b 100644 --- a/ports.html +++ b/ports.html @@ -193,11 +193,13 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API

    • @@ -215,7 +217,7 @@

    diff --git a/powershell.html b/powershell.html index 4923698f2..5f7e8941b 100644 --- a/powershell.html +++ b/powershell.html @@ -197,11 +197,13 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API

    • @@ -251,7 +253,7 @@

    diff --git a/proxy-guide.html b/proxy-guide.html index 7f9013c3b..f413a9f6e 100644 --- a/proxy-guide.html +++ b/proxy-guide.html @@ -201,11 +201,13 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API
    • @@ -277,7 +279,7 @@

    diff --git a/reverse-proxies.html b/reverse-proxies.html index 43b684bb9..d5c0508d0 100644 --- a/reverse-proxies.html +++ b/reverse-proxies.html @@ -201,11 +201,13 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API
    • @@ -256,7 +258,7 @@

    diff --git a/snapsnots.html b/snapsnots.html index 2090af787..a607ab514 100644 --- a/snapsnots.html +++ b/snapsnots.html @@ -183,34 +183,36 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions +
    • +
  • 12. Reference
    • -
  • 12. Support & Troubleshooting +
  • 13. Support & Troubleshooting
    • -
  • 13. API +
  • 14. API
    • -

    11.7. Snapshot builds

    +

    12.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.

    @@ -233,7 +235,7 @@

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

    -

    11.7.1. Download the snapshot archive

    +

    12.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.

    @@ -261,7 +263,7 @@

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

    diff --git a/solutions.html b/solutions.html new file mode 100644 index 000000000..30fa30f99 --- /dev/null +++ b/solutions.html @@ -0,0 +1,235 @@ + + + + + + + + +OliveTin documentation + + + + + +
    +
    +

    11. Solutions

    +
    +
    +

    OliveTin was designed to be very simple, but sometimes OliveTin can get complex - especially if you are trying to do something where you need to jump between lots of different parts of the documentation!

    +
    +
    +

    This section of the docs is designed to bring everything into one place and present a scenario, with a single-page solution.

    +
    +
    + +
    +
    +
    +
    +

    ← Previous: JWT Authorization | ↑ Up: OliveTin documentation | Next: Homelab Container Control Panel (Traefik, Docker) →

    +
    +
    + + + \ No newline at end of file diff --git a/sosreport.html b/sosreport.html index 64e6caa5f..7a9a8375b 100644 --- a/sosreport.html +++ b/sosreport.html @@ -183,34 +183,36 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference +
    • +
  • 13. Support & Troubleshooting
    • -
  • 13. API +
  • 14. API
    • -

    12.2. sosreport

    +

    13.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!

    @@ -243,7 +245,7 @@

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

    -

    12.2.1. How do I generate a sosreport?

    +

    13.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

    @@ -263,7 +265,7 @@

    -

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

    +

    13.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.

    @@ -275,7 +277,7 @@

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

    diff --git a/support.html b/support.html index dd3846a5e..959844c7d 100644 --- a/support.html +++ b/support.html @@ -183,34 +183,36 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference +
    • +
  • 13. Support & Troubleshooting
    • -
  • 13. API +
  • 14. API
    • -

    12.1. Where to find help

    +

    13.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.

    @@ -228,7 +230,7 @@

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

    diff --git a/timeout.html b/timeout.html index 612d22dab..7717033f4 100644 --- a/timeout.html +++ b/timeout.html @@ -193,11 +193,13 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API
    • @@ -252,7 +254,7 @@

    diff --git a/timezone.html b/timezone.html index 34040c056..79bad9e95 100644 --- a/timezone.html +++ b/timezone.html @@ -193,11 +193,13 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API

    • @@ -233,7 +235,7 @@

    -Last updated 2024-02-21 17:20:06 UTC +Last updated 2024-02-21 17:25:02 UTC
    diff --git a/toggle-webui.html b/toggle-webui.html index ad3b60b71..767b96d34 100644 --- a/toggle-webui.html +++ b/toggle-webui.html @@ -307,11 +307,13 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API
    • @@ -392,7 +394,7 @@

    diff --git a/troubleshooting.html b/troubleshooting.html index 6d0debb38..4ced666dd 100644 --- a/troubleshooting.html +++ b/troubleshooting.html @@ -183,34 +183,36 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference +
    • +
  • 13. Support & Troubleshooting
    • -
  • 13. API +
  • 14. API
    • -

    12. Support & Troubleshooting

    +

    13. Support & Troubleshooting

    -
  • 11. Reference +
  • 11. Solutions
    • -
  • 12. Support & Troubleshooting +
  • 12. Reference
    • -
  • 13. API +
  • 13. Support & Troubleshooting +
    • +
  • 14. API
    • @@ -231,7 +233,7 @@

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

    diff --git a/update-tracking.html b/update-tracking.html index c643dc5bf..6c582778a 100644 --- a/update-tracking.html +++ b/update-tracking.html @@ -183,34 +183,36 @@

    OliveTin

  • 10. Authentication & Authorization
    • -
  • 11. Reference +
  • 11. Solutions +
    • +
  • 12. Reference
    • -
  • 12. Support & Troubleshooting +
  • 13. Support & Troubleshooting
    • -
  • 13. API +
  • 14. API
    • -

    11.4. Update Checks (and tracking)

    +

    12.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.

    @@ -218,7 +220,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).

    -

    11.4.1. Design considerations

    +

    12.4.1. Design considerations

    • @@ -243,7 +245,7 @@

    -

    11.4.2. What is sent (and tracked)

    +

    12.4.2. What is sent (and tracked)

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

    @@ -279,7 +281,7 @@

    -

    11.4.3. What is the OliveTin installation ID?

    +

    12.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.

    @@ -291,7 +293,7 @@

    -

    11.4.4. Why do you need my machine ID?

    +

    12.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.

    @@ -310,7 +312,7 @@

    -

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

    +

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

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

    @@ -329,7 +331,7 @@

    -

    11.4.6. What is stored?

    +

    12.4.6. What is stored?

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

    @@ -338,7 +340,7 @@

    -

    11.4.7. What is not sent/stored

    +

    12.4.7. What is not sent/stored

    -

    11.4.9. Why isn’t this opt-in?

    +

    12.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.

    @@ -369,7 +371,7 @@

    <

    -

    11.4.10. How do I disable update checking?

    +

    12.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.

    @@ -383,7 +385,7 @@

    <

    -

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

    +

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

    Set the following in your configuration file;

    @@ -397,7 +399,7 @@

    -

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

    +

    12.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!

    @@ -418,7 +420,7 @@

    11