Musselman/notatio
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

📝 Docs: Add Quadlets and small changes to README

Browse source 
Yay for Quadlets!
This commit is contained in:
James Musselman 2024-06-30 00:46:43 -05:00
parent bd2eb8a93c
commit c2bbf42321
Signed by: Musselman
GPG key ID: 1DAEFF35ECB5D6DB
4 changed files with 36 additions and 4 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

10
README.md
View file

@ -3,9 +3,9 @@
## 💡 About ## 💡 About
**Notatio is currently under heavy development! **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). 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. 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. 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. 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. 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) ### 🛠️ 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 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 ## 🤝 Contributing

17
quadlets/notatio.container Normal file
View file

@ -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

5
quadlets/notatio.network Normal file
View file

@ -0,0 +1,5 @@
[Install]
WantedBy=default.target
[Network]
NetworkName=notatio-network

8
quadlets/postgres.container Normal file
View file

@ -0,0 +1,8 @@
[Install]
WantedBy=default.target
[Container]
ContainerName=postgres
EnvironmentFile=.env
Image=docker.io/library/postgres
Network=notatio.network