Skip to content

Commit 10ce308

Browse files
committed
Docs: Update build instructions README.md
1 parent 3717d38 commit 10ce308

File tree

1 file changed

+25
-9
lines changed

1 file changed

+25
-9
lines changed

README.md

Lines changed: 25 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,22 +5,38 @@
55
[![Go Report Card](https://goreportcard.com/badge/github.com/mdouchement/standardfile)](https://goreportcard.com/report/github.com/mdouchement/standardfile)
66
[![License](https://img.shields.io/github/license/mdouchement/standardfile.svg)](http://opensource.org/licenses/MIT)
77

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.
99

1010
### Running your own server
1111

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.
1531

16-
- `git clone https://github.com/Crusader99/standardnote-server.git`
17-
- `cd standardnote-server`
18-
- `docker compose up`
1932

2033
<details>
21-
<summary>Running without docker-compose is also possible</summary>
34+
<summary>Build the image</summary>
2235

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`
2440

2541
</details>
2642

0 commit comments

Comments
 (0)