Skip to content

Commit

Permalink
Add deployment docs
Browse files Browse the repository at this point in the history
  • Loading branch information
hoh committed Dec 12, 2024
1 parent 05b23e7 commit 30bf88a
Show file tree
Hide file tree
Showing 3 changed files with 24 additions and 2 deletions.
12 changes: 12 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,18 @@ Use it to explore the available endpoints.

Use with a tool such as [Uptime Kuma](https://github.com/louislam/uptime-kuma).

## Deployment

```shell
hatch run deployment:aleph program upload src monitoring_proxy:app
```

Update an existing deployment:

```shell
hatch run deployment:aleph program update $ITEM_HASH src
```

## Development

```shell
Expand Down
9 changes: 9 additions & 0 deletions pyproject.toml
Original file line number Diff line number Diff line change
Expand Up @@ -90,6 +90,15 @@ all = [
"typing",
]

[tool.hatch.envs.deployment]
detached = true
dependencies = [
"aleph-client==1.3.0",
]
[tool.hatch.envs.deployment.scripts]
deploy = "program upload src monitoring_proxy:app"
update = "program update $ITEM_HASH monitoring_proxy:app"

[tool.mypy]
python_version = "3.11"
install_types = true
Expand Down
5 changes: 3 additions & 2 deletions src/monitoring_proxy/templates/index.html
Original file line number Diff line number Diff line change
Expand Up @@ -14,11 +14,12 @@ <h1>Monitoring Proxy</h1>
<p>Monitoring Proxy is a simple service that allows you to monitor the health of your services.</p>
<div>
<p>
<a href="/docs">Swagger UI</a>
<a href="./docs">Swagger UI</a>
</p>
<p>
<a href="/redoc">ReDoc</a>
<a href="./redoc">ReDoc</a>
</p>
</div>
<a href="https://aleph.im">aleph.im</a>
</body>
</html>

0 comments on commit 30bf88a

Please sign in to comment.