post_container.adoc 1.9 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263
  1. == Post installation (container)
  2. You will need to write a basic configuration file before OliveTin will startup.
  3. Create a basic config file at `/etc/OliveTin/config.yaml` - the exact path depends on what directory you specified in the bind mount container creation in the last step. Note that the file must be called `config.yaml`, and `config.yml` or `mystuff.yaml` would not work. You can download a sample configuration file like this if you like;
  4. [source,shell]
  5. .Download the sample config.yaml file to get you started.
  6. ----
  7. user@host: cd /etc/OliveTin/
  8. user@host: curl -O https://raw.githubusercontent.com/OliveTin/OliveTin/main/config.yaml
  9. ----
  10. The file contents should look something like this;
  11. .The most simple `config.yaml` file.
  12. [source,yaml]
  13. ----
  14. actions:
  15. - title: "Hello world!"
  16. shell: echo 'Hello World!'
  17. ----
  18. If you are running a firewall on your server, like firewalld, you will need to
  19. open port 1337;
  20. == Configure your firewall
  21. [tabs]
  22. ====
  23. No Firewall:: If you don't have a firewall, continue to the next section.
  24. FirewallD:: This is how you configure your firewalld firewall for OliveTin:
  25. +
  26. [source, shell]
  27. ----
  28. user@host: firewall-cmd --add-port 1337/tcp --permanent
  29. user@host: firewall-cmd --reload
  30. ----
  31. +
  32. ====
  33. == Start the OliveTin service
  34. Now that you have a configuration file, and the OliveTin container created, you are now ready to start OliveTin!
  35. ----
  36. user@host: docker start olivetin
  37. ----
  38. include::partial$install/to_config.adoc[]
  39. == Troubleshooting podman/docker installations
  40. If you are having problems in starting OliveTin, or OliveTin is crashing on startup, then check the logs like this;
  41. ----
  42. user@host: docker logs OliveTin
  43. ----
  44. For more detail on what to capture and how to share logs when asking for help, see xref:troubleshooting/service-logs.adoc[Service logs (troubleshooting)].
  45. If you cannot understand the logs, or otherwise need help, see the xref:troubleshooting/wheretofindhelp.adoc[support page].