add init new files
This commit is contained in:
27
README.md
Normal file
27
README.md
Normal file
@@ -0,0 +1,27 @@
|
||||
# apiservice
|
||||
|
||||
## Run
|
||||
|
||||
1. Copy env
|
||||
|
||||
```bash
|
||||
cp .env.example .env
|
||||
```
|
||||
|
||||
2. Update DB connection env values
|
||||
|
||||
3. Start
|
||||
|
||||
```bash
|
||||
docker compose up --build
|
||||
```
|
||||
|
||||
## Base path
|
||||
|
||||
Set `ROOT_PATH=/apiservice` when running behind reverse proxy.
|
||||
|
||||
## Permissions
|
||||
|
||||
The checkpoint endpoint requires permission:
|
||||
|
||||
- `feed.checkpoint:write`
|
||||
Reference in New Issue
Block a user