Merge pull request #10 from moan0s/hubsite

Hubsite
2023-03-23 08:02:18 +02:00 · 2023-03-23 08:02:18 +02:00 · 142cce2dd3
commit 142cce2dd3
parent 4a05b69e52 3830754102
5 changed files with 153 additions and 2 deletions
--- a/docs/services/hubsite.md
+++ b/docs/services/hubsite.md
@ -0,0 +1,38 @@
+# Hubsite
+
+[Hubsite](https://github.com/moan0s/hubsite) is will provide you with a simple, static site that shows an overview of the available services.
+
+You can use the following variables to enable & control your hubsite:
+
+```yaml
+########################################################################
+#                                                                      #
+# hubsite                                                              #
+#                                                                      #
+########################################################################
+
+hubsite_enabled: true
+
+hubsite_hostname: mash.example.com
+
+hubsite_title: "My services"
+hubsite_subtitle: "Just click on a service to use it"
+
+# Use the `hubsite_service_list_additional` variable to add services that are not provided by this playbook
+# hubsite_service_list: |
+#   {{
+#     ([{'name': 'My blog', 'logo_location': '', 'description': 'A link to a blog not hosted by this playbook'}])
+#   }}
+
+# If you want to explicitly control which services you want to show on this page you can overwrite 
+# hubsite_service_list_auto: |
+#   {{
+#     ([{'name': 'Miniflux', 'logo_location': '{{ role_path }}/assets/miniflux.png', 'description': 'An opinionated feed reader '}])
+#     +
+#     ([{'name': 'Uptime Kuma', 'logo_location': '{{ role_path }}/assets/uptime-kuma.png', 'description': 'Check if the status of services'}])
+#   }}
+########################################################################
+#                                                                      #
+# /hubsite                                                             #
+#                                                                      #
+########################################################################
--- a/docs/supported-services.md
+++ b/docs/supported-services.md
@ -8,9 +8,10 @@
 | [Docker Registry](https://docs.docker.com/registry/) | A container image distribution registry | [Link](services/docker-registry.md) |
 | [Docker Registry Browser](https://github.com/klausmeyer/docker-registry-browser) | Web Interface for the Docker Registry HTTP API V2 written in Ruby on Rails | [Link](services/docker-registry-browser.md) |
 | [Docker Registry Purger](https://github.com/devture/docker-registry-purger) | A small tool used for purging a private Docker Registry's old tags | [Link](services/docker-registry-purger.md) |
-| [Gitea](https://gitea.io/) | A painless self-hosted Git service. | [Link](services/gitea.md) |
-| [Grafana](https://grafana.com/) | An open and composable observability and data visualization platform, often used with [Prometheus](services/prometheus.md) | [Link](services/grafana.md) |
 | [Focalboard](https://www.focalboard.com/) | An open source, self-hosted alternative to [Trello](https://trello.com/), [Notion](https://www.notion.so/), and [Asana](https://asana.com/). | [Link](services/focalboard.md) |
+| [Gitea](https://gitea.io/) | A painless self-hosted Git service. | [Link](services/gitea.md) |
+| [Grafana](https://grafana.com/) | An open and composable observability and data visualization platform, often used with [Prometheus](services/prometheus.md) | [Link](services/grafana.md) | 
+| [Hubsite](https://github.com/moan0s/hubsite) | A simple, static site that shows an overview of the available services | [Link](services/hubsite.md) | 
 | [Miniflux](https://miniflux.app/) | Minimalist and opinionated feed reader. | [Link](services/miniflux.md) |
 | [Nextcloud](https://nextcloud.com/) | The most popular self-hosted collaboration solution for tens of millions of users at thousands of organizations across the globe. | [Link](services/nextcloud.md) |
 | [PeerTube](https://joinpeertube.org/) | A tool for sharing online videos | [Link](services/peertube.md) |
@ -39,3 +40,4 @@
 |              Name              |              Description              |
 | ------------------------------ | ------------------------------------- |
 | [Garage](https://garagehq.deuxfleurs.fr/), by absorbing [garage-docker-ansible-deploy](https://github.com/moan0s/garage-docker-ansible-deploy) | Open-source distributed object storage service tailored for self-hosting |
+
--- a/group_vars/mash_servers
+++ b/group_vars/mash_servers
@ -114,6 +114,8 @@ devture_systemd_service_manager_services_list_auto: |
    ([{'name': (vaultwarden_identifier + '.service'), 'priority': 2000, 'groups': ['mash', 'vaultwarden', 'vaultwarden-server']}] if vaultwarden_enabled else [])
    +
    ([{'name': (uptime_kuma_identifier + '.service'), 'priority': 2000, 'groups': ['mash', 'uptime-kuma']}] if uptime_kuma_enabled else [])
+    +
+    ([{'name': (hubsite_identifier + '.service'), 'priority': 2000, 'groups': ['mash', 'hubsite']}] if hubsite_enabled else [])
  }}

 ########################################################################
@ -1151,3 +1153,106 @@ devture_woodpecker_ci_agent_config_agent_secret: "{{ devture_woodpecker_ci_serve
 # /woodpecker-ci-agent                                                 #
 #                                                                      #
 ########################################################################
+
+########################################################################
+#                                                                      #
+# hubsite                                                              #
+#                                                                      #
+########################################################################
+
+hubsite_enabled: false
+
+hubsite_identifier: "{{ mash_playbook_service_identifier_prefix }}hubsite"
+
+hubsite_base_path: "{{ mash_playbook_base_path }}/hubsite"
+
+hubsite_uid: "{{ mash_playbook_uid }}"
+hubsite_gid: "{{ mash_playbook_gid }}"
+
+hubsite_systemd_required_services_list: |
+  {{
+    (['docker.service'])
+  }}
+
+hubsite_container_additional_networks: |
+  {{
+    ([mash_playbook_reverse_proxyable_services_additional_network] if mash_playbook_reverse_proxyable_services_additional_network else [])
+  }}
+
+hubsite_container_labels_traefik_enabled: "{{ mash_playbook_traefik_labels_enabled }}"
+hubsite_container_labels_traefik_docker_network: "{{ mash_playbook_reverse_proxyable_services_additional_network }}"
+hubsite_container_labels_traefik_entrypoints: "{{ devture_traefik_entrypoint_primary }}"
+hubsite_container_labels_traefik_tls_certResolver: "{{ devture_traefik_certResolver_primary }}"
+
+# Services
+##########
+
+# Gitea
+hubsite_service_gitea_enabled: "{{ gitea_enabled }}"
+hubsite_service_gitea_name: Gitea
+hubsite_service_gitea_url: "https://{{ gitea_hostname }}{{ gitea_path_prefix }}"
+hubsite_service_gitea_logo_location: "{{ role_path }}/assets/gitea.png"
+hubsite_service_gitea_description: "A git service"
+hubsite_service_gitea_priority: 1000
+
+# Miniflux
+hubsite_service_miniflux_enabled: "{{ miniflux_enabled }}"
+hubsite_service_miniflux_name: Miniflux
+hubsite_service_miniflux_url: "https://{{ miniflux_hostname }}{{ miniflux_path_prefix }}"
+hubsite_service_miniflux_logo_location: "{{ role_path }}/assets/miniflux.png"
+hubsite_service_miniflux_description: "An opinionated feed reader"
+hubsite_service_miniflux_priority: 1000
+
+# Nextcloud
+hubsite_service_nextcloud_enabled: "{{ nextcloud_enabled }}"
+hubsite_service_nextcloud_name: Nextcloud
+hubsite_service_nextcloud_url: "https://{{ nextcloud_hostname }}{{ nextcloud_path_prefix }}"
+hubsite_service_nextcloud_logo_location: "{{ role_path }}/assets/nextcloud.png"
+hubsite_service_nextcloud_description: "Sync your files & much more"
+hubsite_service_nextcloud_priority: 1000
+
+# Peertube
+hubsite_service_peertube_enabled: "{{ peertube_enabled }}"
+hubsite_service_peertube_name: Peertube
+hubsite_service_peertube_url: "https://{{ peertube_hostname }}{{ peertube_path_prefix }}"
+hubsite_service_peertube_logo_location: "{{ role_path }}/assets/peertube.png"
+hubsite_service_peertube_description: "Watch and upload videos"
+hubsite_service_peertube_priority: 1000
+
+# Uptime Kuma
+hubsite_service_uptime_kuma_enabled: "{{ uptime_kuma_enabled }}"
+hubsite_service_uptime_kuma_name: Uptime Kuma
+hubsite_service_uptime_kuma_url: "https://{{ uptime_kuma_hostname }}{{ uptime_kuma_path_prefix }}"
+hubsite_service_uptime_kuma_logo_location: "{{ role_path }}/assets/uptime-kuma.png"
+hubsite_service_uptime_kuma_description: "An opinionated feed reader"
+hubsite_service_uptime_kuma_priority: 1000
+
+# Vaultwarden
+# The vaultwarden service link is deactivated by default for security reasons, see: https://github.com/dani-garcia/vaultwarden/wiki/Hardening-Guide#hiding-under-a-subdir
+hubsite_service_vaultwarden_enabled: false
+hubsite_service_vaultwarden_name: Vaultwarden
+hubsite_service_vaultwarden_url: "https://{{ vaultwarden_hostname }}{{ vaultwarden_path_prefix }}"
+hubsite_service_vaultwarden_logo_location: "{{ role_path }}/assets/vaultwarden.png"
+hubsite_service_vaultwarden_description: "Securely access your passwords"
+hubsite_service_vaultwarden_priority: 1000
+
+hubsite_service_list_auto: |
+  {{
+    ([{'name': hubsite_service_gitea_name, 'url': hubsite_service_gitea_url, 'logo_location': hubsite_service_gitea_logo_location, 'description': hubsite_service_gitea_description, 'priority': hubsite_service_gitea_priority}] if hubsite_service_gitea_enabled else [])
+    +
+    ([{'name': hubsite_service_miniflux_name, 'url': hubsite_service_miniflux_url, 'logo_location': hubsite_service_miniflux_logo_location, 'description': hubsite_service_miniflux_description, 'priority': hubsite_service_miniflux_priority}] if hubsite_service_miniflux_enabled else [])
+    +
+    ([{'name': hubsite_service_nextcloud_name, 'url': hubsite_service_nextcloud_url, 'logo_location': hubsite_service_nextcloud_logo_location, 'description': hubsite_service_nextcloud_description, 'priority': hubsite_service_nextcloud_priority}] if hubsite_service_nextcloud_enabled else [])
+    +
+    ([{'name': hubsite_service_peertube_name, 'url': hubsite_service_peertube_url, 'logo_location': hubsite_service_peertube_logo_location, 'description': hubsite_service_peertube_description, 'priority': hubsite_service_peertube_priority}] if hubsite_service_peertube_enabled else [])
+    +
+    ([{'name': hubsite_service_uptime_kuma_name, 'url': hubsite_service_uptime_kuma_url, 'logo_location': hubsite_service_uptime_kuma_logo_location, 'description': hubsite_service_uptime_kuma_description, 'priority': hubsite_service_uptime_kuma_priority}] if hubsite_service_uptime_kuma_enabled else [])
+    +
+    ([{'name': hubsite_service_vaultwarden_name, 'url': hubsite_service_vaultwarden_url, 'logo_location': hubsite_service_vaultwarden_logo_location, 'description': hubsite_service_vaultwarden_description, 'priority': hubsite_service_vaultwarden_priority}] if hubsite_service_vaultwarden_enabled else [])
+  }}
+
+########################################################################
+#                                                                      #
+# /hubsite                                                             #
+#                                                                      #
+########################################################################
--- a/requirements.yml
+++ b/requirements.yml
@ -118,3 +118,7 @@
 - src: git+https://github.com/mother-of-all-self-hosting/ansible-role-vaultwarden.git
  name: vaultwarden
  version: v1.27.0-2
+
+- src: git+https://github.com/moan0s/hubsite.git
+  name: hubsite
+  version: da6fed398a9dd0761db941cb903b53277c341cc6
--- a/setup.yml
+++ b/setup.yml
@ -68,6 +68,8 @@

    - role: galaxy/miniflux

+    - role: galaxy/hubsite
+
    - role: galaxy/nextcloud

    - role: galaxy/peertube