Skip to content

Commit 9f21392

Browse files
committed
feat: Docs for helm charts
1 parent 80fa48b commit 9f21392

File tree

2 files changed

+62
-8
lines changed

2 files changed

+62
-8
lines changed

helm/README.md

Lines changed: 34 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,34 @@
1+
<h1 align="center">Domain Locker</h1>
2+
<p align="center">
3+
<i>Track, manage and monitor all your domain names in once place</i>
4+
<br>
5+
<b>🌐<a href="https://domain-locker.com">domain-locker.com</a></b>
6+
<br>
7+
<b>🐙<a href="https://github.com/Lissy93/domain-locker">github.com/lissy93/domain-locker</a></b>
8+
</p>
9+
10+
### Features
11+
- 👁️ Total visibility of all your domains and upcoming expirations
12+
- 📡 Auto-fetched data: SSL certs, hosts, registrars, IPs, subdomains, DNS, etc
13+
- 🔬 View detailed metrics and analysis for each domain
14+
- 📊 Visual analytics and breakdowns and trends across your portfolio
15+
- 💬 Configurable alerts and webhook notifications
16+
- 🗃️ Easy import/export, as well as API data access
17+
- 📜 Track changes in domain configuration over time
18+
- 📈 Monitor website health, security and performance
19+
- 💹 Keep record of purchase prices and renewal costs
20+
- 🔖 Add categories, and link related resources to domains
21+
- 🎨 Multi-language support, dark/light/custom themes
22+
23+
### Install
24+
- [Docker](https://domain-locker.com/about/self-hosting/deploying-with-docker-compose)
25+
- [Kubernetes](https://domain-locker.com/about/self-hosting/deploying-with-kubernetes-helm-charts)
26+
- [From Source](https://domain-locker.com/about/self-hosting/deploying-from-source)
27+
- [...More install methods](https://domain-locker.com/about/self-hosting)
28+
29+
### License
30+
Domain-Locker is licensed under [MIT](https://github.com/Lissy93/domain-locker/blob/HEAD/LICENSE) © [Alicia Sykes](https://aliciasykes.com) 2025.
31+
32+
<p align="center">
33+
<a href="https://domain-locker.com"><img width="420" src="https://github.com/Lissy93/domain-locker/blob/main/src/assets/og.png?raw=true" /></a>
34+
</p>

src/content/docs/self-hosting/kubernetes.md

Lines changed: 28 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,9 +7,10 @@ index: 2
77
---
88

99

10-
> [!NOTE]
11-
> This is not officially supported. These helm charts are for reference only. I cannot guarantee k8 support if something does not work as expected, but feel free to submit a pull request
12-
10+
<blockquote class="markdown-alert markdown-alert-note">
11+
Helm charts are provided for reference only, and are not officially supported.
12+
If you encounter issues, please feel free to submit a pull request to improve the documentation or the charts.
13+
</blockquote>
1314

1415
## Installation Prerequisites
1516

@@ -53,15 +54,18 @@ For instructions for your OS, see the [helm docs](https://helm.sh/docs/intro/ins
5354
minikube start
5455
```
5556

56-
This will start a local single-node Kubernetes cluster, add `--driver=docker` for using Docker.
57-
58-
### Spin up domain-locker helm charts
57+
### Add the Helm repository
5958

6059
```bash
61-
helm install dl oci://ghcr.io/lissy93/domain-locker-helm --version 0.0.8 --wait
60+
helm repo add domain-locker https://lissy93.github.io/domain-locker/helm
6261
```
6362

64-
(or, from source, using `helm install dl ./helm`)
63+
64+
### Install the chart
65+
66+
```bash
67+
helm install dl domain-locker/domain-locker --version 0.0.8
68+
```
6569

6670
### Verify it's running
6771

@@ -109,3 +113,19 @@ Manually connect to the database:
109113
```bash
110114
psql -h domain-locker-postgres -U postgres -d domain_locker
111115
```
116+
117+
[![Artifact Hub](https://img.shields.io/endpoint?url=https://artifacthub.io/badge/repository/domain-locker)](https://artifacthub.io/packages/search?repo=domain-locker)
118+
119+
---
120+
121+
## Manual Installation
122+
123+
You can also manually add the repo, from the source.
124+
This is useful if you want to make any changes, or want to maintain your own fork.
125+
The source for the helm charts is in the [`helm`](https://github.com/Lissy93/domain-locker/tree/main/helm) directory.
126+
127+
```bash
128+
git clone [email protected]:Lissy93/domain-locker.git
129+
cd domain-locker
130+
helm install dl ./helm
131+
```

0 commit comments

Comments
 (0)