First Launch
🚀 Add Home Assistant Newt Add-on
Commit description:
Added config.yaml for add-on configuration
Created Dockerfile to build the add-on container
Implemented run.sh to start and manage the Newt container
Included a detailed README.md with installation and usage instructions
Prepared repository for Home Assistant custom add-on support
This commit is contained in:
commit
17337c1323
4 changed files with 152 additions and 0 deletions
10
Dockerfile
Normal file
10
Dockerfile
Normal file
|
@ -0,0 +1,10 @@
|
||||||
|
FROM ghcr.io/hassio-addons/base:14.0.0
|
||||||
|
|
||||||
|
# Install dependencies
|
||||||
|
RUN apk add --no-cache docker-cli
|
||||||
|
|
||||||
|
# Copy the run script
|
||||||
|
COPY run.sh /run.sh
|
||||||
|
RUN chmod +x /run.sh
|
||||||
|
|
||||||
|
CMD [ "/run.sh" ]
|
89
README.md
Normal file
89
README.md
Normal file
|
@ -0,0 +1,89 @@
|
||||||
|
# 🏡 Home Assistant Newt Add-on
|
||||||
|
|
||||||
|
## 📌 About this Add-on
|
||||||
|
This Home Assistant add-on allows you to easily run **Newt** from [Fossorial](https://docs.fossorial.io/Newt/overview) directly in Home Assistant. The add-on lets you configure **PANGOLIN_ENDPOINT**, **NEWT_ID**, and **NEWT_SECRET** via the Home Assistant interface.
|
||||||
|
|
||||||
|
## 🚀 Features
|
||||||
|
✅ Easy installation via Home Assistant Add-on Store
|
||||||
|
✅ Automated setup and execution of the Newt container
|
||||||
|
✅ Supports `amd64`, `armv7`, `armhf`, and `aarch64` architectures
|
||||||
|
✅ Automatic restart on crash
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🛠️ Installation
|
||||||
|
|
||||||
|
### **1️⃣ Add the GitHub Repository as an Add-on Source**
|
||||||
|
1. Go to **Settings → Add-ons → Add-on Store**.
|
||||||
|
2. Click the menu (three dots in the top right) and select **Repositories**.
|
||||||
|
3. Add the following URL:
|
||||||
|
```
|
||||||
|
https://github.com/username/home-assistant-newt-addon
|
||||||
|
```
|
||||||
|
4. Click **Add** and wait for the repository to load.
|
||||||
|
|
||||||
|
### **2️⃣ Install and Start the Add-on**
|
||||||
|
1. Find **Newt Add-on** in the list and click **Install**.
|
||||||
|
2. Go to the **Configuration** tab and enter your values for:
|
||||||
|
- **PANGOLIN_ENDPOINT** (e.g., `https://example.com`)
|
||||||
|
- **NEWT_ID**
|
||||||
|
- **NEWT_SECRET**
|
||||||
|
3. Click **Save** and then **Start**.
|
||||||
|
4. Check the **Logs** tab to verify that everything is running correctly.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## ⚙️ Configuration
|
||||||
|
After installation, you can configure the add-on via the Home Assistant UI:
|
||||||
|
|
||||||
|
```yaml
|
||||||
|
PANGOLIN_ENDPOINT: "https://example.com"
|
||||||
|
NEWT_ID: "your_newt_id"
|
||||||
|
NEWT_SECRET: "your_newt_secret"
|
||||||
|
```
|
||||||
|
|
||||||
|
### **Docker Environment Variables**
|
||||||
|
The following environment variables are passed to the `Newt` container:
|
||||||
|
- `PANGOLIN_ENDPOINT`
|
||||||
|
- `NEWT_ID`
|
||||||
|
- `NEWT_SECRET`
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🔍 Troubleshooting
|
||||||
|
💡 **Add-on does not start?**
|
||||||
|
- Check the logs in Home Assistant (`Settings → Add-ons → Newt → Logs`).
|
||||||
|
- Ensure that `PANGOLIN_ENDPOINT`, `NEWT_ID`, and `NEWT_SECRET` are set correctly.
|
||||||
|
|
||||||
|
💡 **Changes in configuration do not take effect?**
|
||||||
|
- Restart the add-on after making changes.
|
||||||
|
- Try removing the container manually:
|
||||||
|
```sh
|
||||||
|
docker stop newt
|
||||||
|
docker rm newt
|
||||||
|
```
|
||||||
|
Then start the add-on again.
|
||||||
|
|
||||||
|
💡 **Docker not available?**
|
||||||
|
- Home Assistant OS manages Docker automatically, but check if the system has access to Docker by running:
|
||||||
|
```sh
|
||||||
|
docker info
|
||||||
|
```
|
||||||
|
If this fails, there may be a restriction in Home Assistant OS.
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## 🔗 Useful Links
|
||||||
|
- 📖 [Newt Documentation](https://docs.fossorial.io/Newt/overview)
|
||||||
|
- 🏡 [Home Assistant](https://www.home-assistant.io/)
|
||||||
|
- 🐳 [Docker Docs](https://docs.docker.com/)
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
## ❤️ Contribute
|
||||||
|
Have suggestions for improvements? Create a **Pull Request** or report an issue in the **Issues** tab!
|
||||||
|
|
||||||
|
---
|
||||||
|
|
||||||
|
© 2025 - Made with ❤️ for Home Assistant users 🚀
|
||||||
|
|
21
config.yaml
Normal file
21
config.yaml
Normal file
|
@ -0,0 +1,21 @@
|
||||||
|
name: "Newt Add-on"
|
||||||
|
version: "1.0.0"
|
||||||
|
slug: "newt"
|
||||||
|
description: "Kjører Newt-containeren i Home Assistant"
|
||||||
|
arch:
|
||||||
|
- amd64
|
||||||
|
- armv7
|
||||||
|
- armhf
|
||||||
|
- aarch64
|
||||||
|
startup: "system"
|
||||||
|
boot: "auto"
|
||||||
|
host_network: true
|
||||||
|
privileged: true
|
||||||
|
options:
|
||||||
|
PANGOLIN_ENDPOINT: "https://example.com"
|
||||||
|
NEWT_ID: "your_newt_id"
|
||||||
|
NEWT_SECRET: "your_newt_secret"
|
||||||
|
schema:
|
||||||
|
PANGOLIN_ENDPOINT: "str"
|
||||||
|
NEWT_ID: "str"
|
||||||
|
NEWT_SECRET: "str"
|
32
run.sh
Normal file
32
run.sh
Normal file
|
@ -0,0 +1,32 @@
|
||||||
|
#!/usr/bin/env bash
|
||||||
|
set -e
|
||||||
|
|
||||||
|
echo "Starter Newt container..."
|
||||||
|
|
||||||
|
# Hent verdier fra Home Assistant config
|
||||||
|
PANGOLIN_ENDPOINT=$(bashio::config 'PANGOLIN_ENDPOINT')
|
||||||
|
NEWT_ID=$(bashio::config 'NEWT_ID')
|
||||||
|
NEWT_SECRET=$(bashio::config 'NEWT_SECRET')
|
||||||
|
|
||||||
|
# Sjekk at Docker kjører
|
||||||
|
if ! docker info >/dev/null 2>&1; then
|
||||||
|
echo "Docker er ikke tilgjengelig i Home Assistant OS!"
|
||||||
|
exit 1
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Stopp og fjern gammel container hvis den finnes
|
||||||
|
if docker ps -a --format '{{.Names}}' | grep -q "newt"; then
|
||||||
|
docker stop newt
|
||||||
|
docker rm newt
|
||||||
|
fi
|
||||||
|
|
||||||
|
# Kjør Newt-containeren
|
||||||
|
docker run -d --restart unless-stopped \
|
||||||
|
--name newt \
|
||||||
|
-e PANGOLIN_ENDPOINT="$PANGOLIN_ENDPOINT" \
|
||||||
|
-e NEWT_ID="$NEWT_ID" \
|
||||||
|
-e NEWT_SECRET="$NEWT_SECRET" \
|
||||||
|
fosrl/newt
|
||||||
|
|
||||||
|
echo "Newt-container kjører!"
|
||||||
|
exec tail -f /dev/null
|
Loading…
Add table
Add a link
Reference in a new issue