docs: remove goofy sections from README

This commit is contained in:
corrado.mulas
2026-04-06 13:57:10 +02:00
parent c17a71a1cc
commit 36676db1dd
5 changed files with 131 additions and 26 deletions

View File

@@ -121,8 +121,7 @@ Edit `.env` and set required variables.
### 2) Install dependencies and run
```bash
go mod init main
go mod tidy
go mod download
go run .
```
@@ -142,15 +141,6 @@ Run container:
docker run --rm -p 3000:3000 --env-file .env overleaf-registration-be
```
## Security Notes
- Do not commit real credentials or `.env`.
- Restrict CORS origins in production. Current code allows all origins (`*`).
- Use HTTPS between client and backend.
- Use least-privilege admin account where possible.
- Rotate admin and Turnstile secrets regularly.
- Avoid logging sensitive token values in production.
## Operational Notes
- Startup fails fast when required env vars are missing.
@@ -177,15 +167,6 @@ GitLab CI currently includes SAST template in `.gitlab-ci.yml`.
- `CSRF token not found`
- Overleaf login/admin page markup may have changed.
## Suggested Improvements
- Add structured logging and log levels
- Replace broad CORS policy with strict allowed origins
- Add health endpoint (`/healthz`)
- Add unit/integration tests
- Add explicit request timeouts and retry strategy
- Create and commit a proper `go.mod` / `go.sum`
## License
This project is licensed under the BSD 3-Clause License - see the [LICENSE](LICENSE) file for details.