mirror of
https://github.com/teslamate-org/teslamate.git
synced 2026-01-24 21:06:08 +08:00
Update docs
This commit is contained in:
@@ -1,89 +1,86 @@
|
||||
---
|
||||
title: Installation
|
||||
title: Docker install
|
||||
sidebar_label: Docker
|
||||
---
|
||||
|
||||
This document provides the necessary steps for installation of TeslaMate on a any system that runs Docker. For a walkthrough that provides the necessary steps for manual installation see [Manual Install](debian).
|
||||
|
||||
This setup is recommended only if you are running TeslaMate **on your home network**, as otherwise your Tesla API tokens might be at risk. If you intend to expose TeslaMate directly to the internet check out the [advanced guides](../guides/traefik).
|
||||
|
||||
## Requirements
|
||||
|
||||
:::tip
|
||||
If you are new to Docker, see [Installing Docker and Docker Compose](https://dev.to/rohansawant/installing-docker-and-docker-compose-on-the-raspberry-pi-in-5-simple-steps-3mgl)
|
||||
:::
|
||||
|
||||
- Docker
|
||||
- Docker _(if you are new to Docker, see [Installing Docker and Docker Compose](https://dev.to/rohansawant/installing-docker-and-docker-compose-on-the-raspberry-pi-in-5-simple-steps-3mgl))_
|
||||
- A Machine that's always on, so TeslaMate can continually fetch data
|
||||
- External internet access, to talk to tesla.com
|
||||
|
||||
## Setup
|
||||
## Instructions
|
||||
|
||||
Create a file called `docker-compose.yml` with the following content:
|
||||
1. Create a file called `docker-compose.yml` with the following content:
|
||||
|
||||
```yml title="docker-compose.yml"
|
||||
version: "3"
|
||||
```yml title="docker-compose.yml"
|
||||
version: "3"
|
||||
|
||||
services:
|
||||
teslamate:
|
||||
image: teslamate/teslamate:latest
|
||||
restart: always
|
||||
environment:
|
||||
- DATABASE_USER=teslamate
|
||||
- DATABASE_PASS=secret
|
||||
- DATABASE_NAME=teslamate
|
||||
- DATABASE_HOST=database
|
||||
- MQTT_HOST=mosquitto
|
||||
ports:
|
||||
- 4000:4000
|
||||
volumes:
|
||||
- ./import:/opt/app/import
|
||||
cap_drop:
|
||||
- all
|
||||
services:
|
||||
teslamate:
|
||||
image: teslamate/teslamate:latest
|
||||
restart: always
|
||||
environment:
|
||||
- DATABASE_USER=teslamate
|
||||
- DATABASE_PASS=secret
|
||||
- DATABASE_NAME=teslamate
|
||||
- DATABASE_HOST=database
|
||||
- MQTT_HOST=mosquitto
|
||||
ports:
|
||||
- 4000:4000
|
||||
volumes:
|
||||
- ./import:/opt/app/import
|
||||
cap_drop:
|
||||
- all
|
||||
|
||||
database:
|
||||
image: postgres:12
|
||||
restart: always
|
||||
environment:
|
||||
- POSTGRES_USER=teslamate
|
||||
- POSTGRES_PASSWORD=secret
|
||||
- POSTGRES_DB=teslamate
|
||||
volumes:
|
||||
- teslamate-db:/var/lib/postgresql/data
|
||||
database:
|
||||
image: postgres:12
|
||||
restart: always
|
||||
environment:
|
||||
- POSTGRES_USER=teslamate
|
||||
- POSTGRES_PASSWORD=secret
|
||||
- POSTGRES_DB=teslamate
|
||||
volumes:
|
||||
- teslamate-db:/var/lib/postgresql/data
|
||||
|
||||
grafana:
|
||||
image: teslamate/grafana:latest
|
||||
restart: always
|
||||
environment:
|
||||
- DATABASE_USER=teslamate
|
||||
- DATABASE_PASS=secret
|
||||
- DATABASE_NAME=teslamate
|
||||
- DATABASE_HOST=database
|
||||
ports:
|
||||
- 3000:3000
|
||||
volumes:
|
||||
- teslamate-grafana-data:/var/lib/grafana
|
||||
grafana:
|
||||
image: teslamate/grafana:latest
|
||||
restart: always
|
||||
environment:
|
||||
- DATABASE_USER=teslamate
|
||||
- DATABASE_PASS=secret
|
||||
- DATABASE_NAME=teslamate
|
||||
- DATABASE_HOST=database
|
||||
ports:
|
||||
- 3000:3000
|
||||
volumes:
|
||||
- teslamate-grafana-data:/var/lib/grafana
|
||||
|
||||
mosquitto:
|
||||
image: eclipse-mosquitto:1.6
|
||||
restart: always
|
||||
ports:
|
||||
- 1883:1883
|
||||
volumes:
|
||||
- mosquitto-conf:/mosquitto/config
|
||||
- mosquitto-data:/mosquitto/data
|
||||
mosquitto:
|
||||
image: eclipse-mosquitto:1.6
|
||||
restart: always
|
||||
ports:
|
||||
- 1883:1883
|
||||
volumes:
|
||||
- mosquitto-conf:/mosquitto/config
|
||||
- mosquitto-data:/mosquitto/data
|
||||
|
||||
volumes:
|
||||
teslamate-db:
|
||||
teslamate-grafana-data:
|
||||
mosquitto-conf:
|
||||
mosquitto-data:
|
||||
```
|
||||
volumes:
|
||||
teslamate-db:
|
||||
teslamate-grafana-data:
|
||||
mosquitto-conf:
|
||||
mosquitto-data:
|
||||
```
|
||||
|
||||
## Start Docker containers
|
||||
2. Start start the docker containers with `docker-compose up`. To run the containers in the background add the `-d` flag:
|
||||
|
||||
Afterwards start the stack with `docker-compose up`. To run the containers in the background add the `-d` flag:
|
||||
|
||||
```bash
|
||||
docker-compose up -d
|
||||
```
|
||||
```bash
|
||||
docker-compose up -d
|
||||
```
|
||||
|
||||
## Usage
|
||||
|
||||
@@ -91,6 +88,3 @@ docker-compose up -d
|
||||
2. Sign in with your Tesla account
|
||||
3. The Grafana dashboards are available at [http://your-ip-address:3000](http://localhost:3000).
|
||||
|
||||
:::caution
|
||||
This setup is recommended only if you are running TeslaMate **on your home network**, as otherwise your Tesla API tokens might be at risk. If you intend to expose TeslaMate directly to the internet consider using one the [advanced Docker installs](docker_advanced).
|
||||
:::
|
||||
|
||||
Reference in New Issue
Block a user