3 Commits
Author SHA1 Message Date
nyeki 7f96eab2c4 Update git repo link in docs 2026-07-16 02:43:19 -03:00
nyeki 682ef1f285 Update README Docker instructions 2026-07-16 02:41:20 -03:00
nyeki eb94fb8e54 Move docs and healthcheck at /* to /v1 /* 2026-07-16 02:36:08 -03:00
2 changed files with 5 additions and 5 deletions
+1 -1
View File
@@ -36,7 +36,7 @@ CLI arguments go after the `--` in the cargo command.
To run deploy the API with Docker, just run:
```sh
$ docker run registry.nyeki.dev/nyeki/api:latest -p 8000:80 \
$ docker run registry.nyeki.dev/nyeki/api:v1.1.4 -p 8000:80 \
$ -e DISCORD_TOKEN="..." \
$ -e GITHUB_TOKEN="..."
```
+4 -4
View File
@@ -9,8 +9,8 @@ pub mod v1;
pub fn router() -> Router<Arc<State>> {
Router::new()
.route("/", get(docs))
.route("/healthcheck", get(healthcheck))
.route("/v1/healthcheck", get(healthcheck))
.route("/v1/docs", get(docs))
.nest("/v1", v1::router())
}
@@ -33,7 +33,7 @@ async fn docs() -> &'static str {
The current endpoints are:
GET /healthcheck
GET /v1/healthcheck
Returns OK when the API is running.
GET /v1/profile
@@ -121,7 +121,7 @@ async fn docs() -> &'static str {
}
```
This API is open source and available at https://git.nyeki.dev/nyeki/api to self-host.
This API is open source and available at https://git.moan.dev/nyeki/nyeki-api to self-host.
Liked it? Found it useful? A donation would be appreciated! You can do so at
https://ko-fi.com/nyeki.
"