diff --git a/docs/services/neko.md b/docs/services/neko.md new file mode 100644 index 0000000..164fede --- /dev/null +++ b/docs/services/neko.md @@ -0,0 +1,46 @@ +# n.eko + +[n.eko](https://neko.m1k1o.net/) is a self-hosted virtual browser, that this playbook can install, powered by the [mother-of-all-self-hosting/ansible-role-neko](https://github.com/mother-of-all-self-hosting/ansible-role-neko) Ansible role. + +**WARNING** The neko service will run in a container with root privileges, no dropped capabilities and will be able to write inside the container. This seems to be a neccessary deviation from the usual security standards in this playbook. + +## Dependencies + +This service requires the following other services: + +- a [Traefik](traefik.md) reverse-proxy server + + +## Configuration + +To enable this service, add the following configuration to your `vars.yml` file and re-run the [installation](../installing.md) process: + +```yaml +######################################################################## +# # +# neko # +# # +######################################################################## + +neko_enabled: true +neko_hostname: 'neko.example.org' +neko_password: 'SECURE_PASSWORD' +neko_password_admin: 'SUPER_SECURE_PASSWORD' + +######################################################################## +# # +# /neko # +# # +######################################################################## +``` + +## Advanced configuration + +There are different flavours of neko and while `firefox` is the default, you can try others by setting + +```yaml +neko_version: "kde" +``` + +All available tags can be found on [Dockerhub](https://hub.docker.com/r/m1k1o/neko/tags) + diff --git a/docs/supported-services.md b/docs/supported-services.md index f815064..4fe017e 100644 --- a/docs/supported-services.md +++ b/docs/supported-services.md @@ -50,6 +50,7 @@ | [Mobilizon](https://joinmobilizon.org/en/) | An ActivityPub/Fediverse server to create and share events. | [Link](services/mobilizon.md) | | [n8n](https://n8n.io/) | Workflow automation for technical people. | [Link](services/n8n.md) | | [Navidrome](https://www.navidrome.org/) | [Subsonic-API](http://www.subsonic.org/pages/api.jsp) compatible music server | [Link](services/navidrome.md) +| [n.eko](https://neko.m1k1o.net/) | A self-hosted virtual browser or even desktop environment | [Link](services/neko.md) | | [NetBox](https://docs.netbox.dev/en/stable/) | Web application that provides [IP address management (IPAM)](https://en.wikipedia.org/wiki/IP_address_management) and [data center infrastructure management (DCIM)](https://en.wikipedia.org/wiki/Data_center_management#Data_center_infrastructure_management) functionality | [Link](services/netbox.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) | | [Outline](https://www.getoutline.com/) | An open-source knowledge base for growing teams. | [Link](services/outline.md) |