Skip to content

Commit

Permalink
Update API URLs
Browse files Browse the repository at this point in the history
  • Loading branch information
AitorAstorga committed Feb 7, 2025
1 parent 2960966 commit 2b3ef34
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 11 deletions.
24 changes: 14 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,6 +4,9 @@
[![Issues][issues-shield]][issues-url]
[![MIT License][license-shield]][license-url]
[![LinkedIn][linkedin-shield]][linkedin-url]
<img
src="https://visitcounter.aichan.ovh/counter/YOUR_PAGE_NAME/svg?label=Visits" height=28
alt="Visit Counter" />

<!-- PROJECT LOGO -->
<br />
Expand Down Expand Up @@ -63,12 +66,12 @@ The Visit Counter API is a lightweight, self‑hostable backend service built in
If you simply want to utilize my API, you can simply add an `img` tag to your site:
```html
<img
src="https://ak5nas.eu/visit_counter/YOUR_PAGE_NAME?label=YOUR_TEXT&color=YOUR_COLOR&style=font-weight:bold;"
src="https://visitcounter.aichan.ovh/counter/YOUR_PAGE_NAME/svg?label=YOUR_TEXT&color=YOUR_COLOR&style=font-weight:bold;"
alt="Visit Counter" />
```

#### Parameters
- Page name: Don't forget to set it `https://ak5nas.eu/visit_counter/YOUR_PAGE_NAME`
- Page name: Don't forget to set it `https://visitcounter.aichan.ovh/counter/YOUR_PAGE_NAME...`
- `label`: The text shown to the left.
- `style`: Directly embed CSS in here. Something like `":root { --background-counter: red; }"` would work.

Expand Down Expand Up @@ -228,14 +231,15 @@ A sample
```yaml
version: "3"
services:
counter:
build: .
ports:
- "8000:8000"
environment:
ROCKET_ADDRESS: "0.0.0.0"
ROCKET_PORT: "8000"
API_KEY: "your_secret_api_key_here"
counter:
container_name: visit-counter
image: ghcr.io/aitorastorga/aichan-visit-counter:latest
ports:
- "8000:8000"
environment:
ROCKET_ADDRESS: "0.0.0.0"
ROCKET_PORT: "8000"
API_KEY: "your_secret_api_key_here"
```
<p align="right">(<a href="#docker-deployment">back to top</a>)</p>
Expand Down
3 changes: 2 additions & 1 deletion docker-compose.yml
Original file line number Diff line number Diff line change
@@ -1,10 +1,11 @@
version: "3"
services:
counter:
container_name: visit-counter
image: ghcr.io/aitorastorga/aichan-visit-counter:latest
ports:
- "8000:8000"
environment:
ROCKET_ADDRESS: "0.0.0.0"
ROCKET_PORT: "8000"
API_KEY: "your_secret_api_key_here"
API_KEY: "your_secret_api_key_here"

0 comments on commit 2b3ef34

Please sign in to comment.