|
5 | 5 | [](https://goreportcard.com/report/github.com/mdouchement/standardfile) |
6 | 6 | [](http://opensource.org/licenses/MIT) |
7 | 7 |
|
8 | | -This is a 100% Golang implementation of the [Standard Notes](https://docs.standardnotes.com/specification/sync) protocol. It aims to be **portable** and **lightweight**. |
| 8 | +**Portable** and **lightweight** Golang implementation of the [Standard Notes](https://docs.standardnotes.com/specification/sync) protocol for self-hosting. |
9 | 9 |
|
10 | 10 | ### Running your own server |
11 | 11 |
|
12 | | -You can run your own Standard File server, and use it with any SF compatible client (like Standard Notes). |
13 | | -This allows you to have 100% control of your data. |
14 | | -This server implementation is built with Go and can be deployed in seconds: |
| 12 | +Create a config file `standardfile.yml`: |
| 13 | +``` |
| 14 | +address: "0.0.0.0:5000" |
| 15 | +no_registration: false |
| 16 | +show_real_version: false |
| 17 | +database_path: "/etc/standardfile/database" |
| 18 | +secret_key: jwt-development |
| 19 | +session: |
| 20 | + secret: paseto-development |
| 21 | + access_token_ttl: 1440h |
| 22 | + refresh_token_ttl: 8760h |
| 23 | +enable_subscription: true |
| 24 | +files_server_url: "http://localhost:5000" |
| 25 | +``` |
| 26 | + |
| 27 | +Setup requires Docker: |
| 28 | +`docker run -p 5000:5000 -v $(pwd)/db:/etc/standardfile/database:z -v $(pwd)/standardfile.yml:/etc/standardfile/standardfile.yml:z -it crusaders/standardnote-server` |
| 29 | + |
| 30 | +Done! You can register and login using Standard Notes after configuring `http://localhost:5000` as custom server. |
15 | 31 |
|
16 | | -- `git clone https://github.com/Crusader99/standardnote-server.git` |
17 | | -- `cd standardnote-server` |
18 | | -- `docker compose up` |
19 | 32 |
|
20 | 33 | <details> |
21 | | -<summary>Running without docker-compose is also possible</summary> |
| 34 | +<summary>Build the image</summary> |
22 | 35 |
|
23 | | -`docker run -p 5000:5000 -v $(pwd)/db:/etc/standardfile/database:z -v $(pwd)/standardfile.yml:/etc/standardfile/standardfile.yml:z -it crusaders/standardnote-server` |
| 36 | +- Requires Earthly for containerized build: https://github.com/earthly/earthly |
| 37 | +- `git clone https://github.com/Crusader99/standardnote-server.git` |
| 38 | +- `cd standardnote-server` |
| 39 | +- `earthly +build` |
24 | 40 |
|
25 | 41 | </details> |
26 | 42 |
|
|
0 commit comments