From d071fa174f5836bd074f08acb9187329d37f1170 Mon Sep 17 00:00:00 2001 From: maindust Date: Wed, 23 Oct 2024 07:19:56 -0500 Subject: [PATCH] Added teslamate's documentation (#315) * Added teslamate's documentation * Teslamate: Code blocks * Teslamate: Fix Postgres link --------- Co-authored-by: owine --- docs/sandbox/apps/teslamate.md | 38 ++++++++++++++++++++++++++++++++++ docs/sandbox/index.md | 1 + mkdocs.yml | 1 + 3 files changed, 40 insertions(+) create mode 100644 docs/sandbox/apps/teslamate.md diff --git a/docs/sandbox/apps/teslamate.md b/docs/sandbox/apps/teslamate.md new file mode 100644 index 000000000..35ad82a80 --- /dev/null +++ b/docs/sandbox/apps/teslamate.md @@ -0,0 +1,38 @@ +# Teslamate + +## What is it? + +[Teslamate](https://github.com/teslamate-org/teslamate) is a powerful, self-hosted data logger for your Tesla. + +| Details | | | | +|-------------|-------------|-------------|-------------| +| [:material-home: Project home](https://github.com/teslamate-org/teslamate){: .header-icons } | [:octicons-link-16: Docs](https://github.com/teslamate-org/teslamate){: .header-icons } | [:octicons-mark-github-16: Github](https://github.com/teslamate-org/teslamate){: .header-icons } | [:material-docker: Docker](https://hub.docker.com/r/teslamate/teslamate){: .header-icons }| + +### 1. Installation + +``` shell + +sb install sandbox-teslamate + +``` + +### 2. URL + +- To access Teslamate, visit `https://teslamate._yourdomain.com_` + +### 3. Setup + +- [:octicons-link-16: Documentation: Teslamate Docs](https://docs.teslamate.org/docs/installation/docker){: .header-icons } + +To use a custom subdomain, add a custom value for `teslamate_web_subdomain` in the `/srv/git/saltbox/inventories/host_vars/localhost.yml` file. More info can be found [here](../../saltbox/inventory/index.md). + +### 4. Grafana Setup + +Once installation is finished, you will need to add the teslamate data source in grafana under connections. + +Host URL: This is based upon the `{{ teslamate_name }}-postgres` variable. Default is `teslamate-postgres:5432` +Table: `teslamate` + +Authentication for Postgres: [Postgres Docs](../../apps/postgres.md) + +Save and Test diff --git a/docs/sandbox/index.md b/docs/sandbox/index.md index 5106fe0b7..d870e8d6a 100644 --- a/docs/sandbox/index.md +++ b/docs/sandbox/index.md @@ -136,6 +136,7 @@ tags: - **[tdarr_node](../sandbox/apps/tdarr-node.md)** - tag - `sandbox-tdarr-node` - **[teamspeak](../sandbox/apps/teamspeak.md)** - tag - `sandbox-teamspeak` - **[telegraf](../sandbox/apps/telegraf.md)** - tag - `sandbox-telegraf` +- **[teslamate](../sandbox/apps/teslamate.md)** - tag - `sandbox-teslamate` - **[thelounge](../sandbox/apps/thelounge.md)** - tag - `sandbox-thelounge` - **[threadfin](../sandbox/apps/threadfin.md)** - tag - `sandbox-threadfin` - **[tika](../sandbox/apps/tika.md)** - tag - `sandbox-tika` diff --git a/mkdocs.yml b/mkdocs.yml index c00e59ea1..7a562507a 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -343,6 +343,7 @@ nav: - Duplicati: sandbox/apps/duplicati.md - SyncThing: sandbox/apps/syncthing.md - Telegraf: sandbox/apps/telegraf.md + - Teslamate: sandbox/apps/teslamate.md - Traefik-Robotstxt: sandbox/apps/traefik-robotstxt.md - Uptime Kuma: sandbox/apps/uptime-kuma.md - Vaultwarden: sandbox/apps/vaultwarden.md