Skip to content

Commit 03b3f07

Browse files
committed
Update README.md
1 parent de926b3 commit 03b3f07

File tree

1 file changed

+8
-0
lines changed

1 file changed

+8
-0
lines changed

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,7 @@ Docker. Build it or check [docker-compose](https://github.com/rhee876527/chiyoga
6060
| DATABASE_PATH | None | For local development use. Conflicts with docker volume paths. |
6161
| DELETE_RETENTION | 90 | Number of days to keep soft-deleted pastes. Valid values: `1-99` |
6262
| COMPLEX_PASSWORD | None | Use `1` to activate. Requires complex password on user registration. Valid password: `Minimum 8 characters, including at least 1 lowercase, 1 uppercase, 1 number and 1 symbol.` |
63+
| ADMIN_CONTACT | None | Accepts email values. May be useful for moderation purposes. |
6364

6465
#### Note about exposing /health to public
6566
Since v1.4.3 this `healthcheck` endpoint was created to actively monitor state of application's database. It has potential for abuse WHEN exposed publicly. Caution is hereby given to protect endpoint (http://localhost:8000/health) from external access as necessary.
@@ -155,6 +156,13 @@ curl -X DELETE http://localhost:8000/paste/EIKq \
155156

156157
**response:** `{"message":"Paste deleted successfully"}`
157158

159+
#### Get instance configuration
160+
161+
```
162+
curl http://localhost:8000/info
163+
```
164+
165+
**response:** `{"ADMIN_CONTACT":"admin@example.com","DELETE_RETENTION":90,"MAX_CHAR_CONTENT":50000,"PASTE_DEFAULT_EXPIRATION":"24h"}`
158166

159167

160168

0 commit comments

Comments
 (0)