diff --git a/README.md b/README.md index 9e6be95..d3477b3 100644 --- a/README.md +++ b/README.md @@ -3,9 +3,9 @@ ## 💡 About **Notatio is currently under heavy development! -As such there is the possibility breaking changes** +As such there is the possibility breaking changes!** -Notatio is a self-hostable, containerized, web-based text editor. +Notatio is a self-hostable, containerized, web-based text editor written in the Go programming language. The main objective of the project is to create a platform independent text editor (and productivity management suite). I hope to develop this as an alternative to proprietary software like obsidian and Notion.so which I have loved and used in the past. This software was originally created as part of a Senior Capstone, but is now being developed in my spare time while job hunting. @@ -43,7 +43,7 @@ git clone https://codeberg.org/musselman/notatio There are two ways to run Notatio. -### 📦 Container (Recommended)\*\* +### 📦 Container (Recommended) --- @@ -74,6 +74,8 @@ podman-compose up -d Please note that using Podman instead of Docker requires you to have Podman installed and properly configured on your system. The usage and setup of Podman may differ from Docker, so please consult the Podman documentation for further information. +For those who use Podman Quadlets, I am pleased to provide them for you in the [Quadlets folder](/quadlets). + ### 🛠️ Go Binary (Advanced) --- @@ -91,7 +93,7 @@ Example command: DB_HOST=127.0.0.1 PGPORT=5432 DB_USER=postgres POSTGRES_PASSWORD=mysecretpassword DB_SSL_MODE=disable ADMIN_USER=admin_user ADMIN_NAME=Admin ADMIN_EMAIL=admin@example.com ADMIN_PASS=admin_is_not_a_good_password! ./notatio ``` -Please note that this method is more advanced and requires additional setup. +Please note that this method is more advanced and requires additional setup such as installing G. ## 🤝 Contributing diff --git a/quadlets/notatio.container b/quadlets/notatio.container new file mode 100644 index 0000000..01d85f4 --- /dev/null +++ b/quadlets/notatio.container @@ -0,0 +1,17 @@ +[Install] +WantedBy=default.target + +[Unit] +Requires=postgres.service +After=postgres.service + +[Container] +AutoUpdate=registry +ContainerName=notatio +EnvironmentFile=.env +Exec=./wait-for-postgres.sh postgres '${PGPORT}' ./notatio +Image=docker.io/notatio/notatio +Network=notatio.network +PublishPort=9991:9991 +Volume=./notatio_uploads:/uploads:Z +Volume=./editor_templates:/editor_templates:Z diff --git a/quadlets/notatio.network b/quadlets/notatio.network new file mode 100644 index 0000000..4e9afef --- /dev/null +++ b/quadlets/notatio.network @@ -0,0 +1,5 @@ +[Install] +WantedBy=default.target + +[Network] +NetworkName=notatio-network diff --git a/quadlets/postgres.container b/quadlets/postgres.container new file mode 100644 index 0000000..695d47e --- /dev/null +++ b/quadlets/postgres.container @@ -0,0 +1,8 @@ +[Install] +WantedBy=default.target + +[Container] +ContainerName=postgres +EnvironmentFile=.env +Image=docker.io/library/postgres +Network=notatio.network