Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added teslamate's documentation #315

Merged
merged 3 commits into from
Oct 23, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
38 changes: 38 additions & 0 deletions docs/sandbox/apps/teslamate.md
Original file line number Diff line number Diff line change
@@ -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
1 change: 1 addition & 0 deletions docs/sandbox/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -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`
Expand Down
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down