Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/arunk140/quillnote-server
Runs a lightweight Nextcloud-like Notes Server. Made for the Quillnote/Quillpad App - https://qosp.org/ OR https://github.com/quillpad/quillpad
https://github.com/arunk140/quillnote-server
docker golang nextcloud note-taking notes self-hosted
Last synced: 2 days ago
JSON representation
Runs a lightweight Nextcloud-like Notes Server. Made for the Quillnote/Quillpad App - https://qosp.org/ OR https://github.com/quillpad/quillpad
- Host: GitHub
- URL: https://github.com/arunk140/quillnote-server
- Owner: arunk140
- License: gpl-3.0
- Created: 2022-11-24T15:59:34.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-04-03T01:23:41.000Z (8 months ago)
- Last Synced: 2024-04-03T02:34:55.334Z (8 months ago)
- Topics: docker, golang, nextcloud, note-taking, notes, self-hosted
- Language: Go
- Homepage:
- Size: 28.3 KB
- Stars: 11
- Watchers: 3
- Forks: 1
- Open Issues: 2
-
Metadata Files:
- Readme: README.md
- License: License
Awesome Lists containing this project
README
# quillnote-server
### currently in development things might break
Runs a lightweight Nextcloud-like Notes Server.
Made for the Quillnote/Quillpad App -
* Maintained Fork - https://github.com/quillpad/quillpad
* Orignal App - [Quillnote](https://github.com/msoultanidis/quillnote))
## Purpose
Use the Sync feature of Quillnote app without a full Nextcloud Instance.
This server emulates all the required APIs for "Notes" from NextCloud.
Currently the notes data is stored in an sqlite db.
## Setup
#### Clone Repo
```
git clone https://github.com/arunk140/quillnote-server.git
cd quillnote-server
```
### With Docker
#### Build Docker Image
```
docker build -f "Dockerfile" -t quillnoteserver:latest "."
```
#### Run Docker Container
```
docker run -d -p 3000:3000/tcp quillnoteserver:latest
```
#### Add User using a Bash Shell in the Container (Optional)
New Users can be created automatically just by logging through the Quillnote/Quillpad App - just choose a username and password when setting up sync settings in the App and a new Account will be created. - This feature should be togglable in the future with an enviroment variable.
```
docker exec -it [container-name/id] sh
./server user add [username] [password]
```
### Without Docker
#### Build
```
go build -o server .
```
#### Init DB (required)
```
./server migrate
```
#### Create User (Optional)
New Users can be created automatically just by logging through the Quillnote/Quillpad App - just choose a username and password when setting up sync settings in the App and a new Account will be created. - This feature should be togglable in the future with an enviroment variable.
```
./server user add [username] [password]
```
#### Run Server
```
./server
```
### Quillnote/Quillpad App
* Maintained Fork - https://github.com/quillpad/quillpad
* Orignal App - https://qosp.org/
In the `Settings` -> `Go to sync settings` -> Set the `Syncing service` to 'Nextcloud'
In the `Nextcloud Instance URL` add the IP:PORT or the URL for this quillnote-server and for the `Nextcloud account` use the username and password you used when adding an account to the server in the server setup.
---
## TODO
* Testing
* Push built Docker Image to a Image Repository
* Add docker-compose
* Add customizable Enviorment Variables
* Suport for Postgres/MySQL ... DBs
* HTTP Server Port and Listen Addr
* Enable/Disable Advanced Logging
* Enable/Disable /metrics Endpoint