docs.teslamate.org Open in urlscan Pro
2a05:d014:58f:6202::64  Public Scan

Form analysis
0 forms found in the DOM

Text Content

Skip to main content

TeslaMateDocs
GitHub



 * Getting started
   * Installation
     * Docker
     * Manual (Debian)
     * Manual (FreeBSD)
   * FAQ
 * Guides
   * Advanced installation with Traefik, Let's Encrypt & HTTP Basic Auth
   * Advanced install with Apache2, TLS, HTTP Basic Auth
   * Web based management of your docker installation
   * Using Unix Domain Sockets with a reverse-proxy
 * Import
   * TeslaFi
   * tesla-apiscraper
 * Integrations
   * HomeAssistant
   * MQTT
   * Node-RED
 * Advanced Configuration
   * Environment Variables
 * Maintenance
   * Upgrading to a new version
   * Backup and Restore
   * Manually fixing data
   * Upgrading PostgreSQL
 * Projects using TeslaMate
 * Development and Contributing

 * 
 * Getting started
 * Installation
 * Docker

On this page


DOCKER INSTALL

This document provides the necessary steps for installation of TeslaMate on any
system that runs Docker. For a walkthrough that provides the necessary steps for
manual installation see Manual installation.

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.


REQUIREMENTS

 * Docker (if you are new to Docker, see Installing Docker and Docker Compose)
 * A Machine that's always on, so TeslaMate can continually fetch data
 * At least 1 GB of RAM on the machine for the installation to succeed.
 * External internet access, to talk to tesla.com


INSTRUCTIONS

 1. Create a file called docker-compose.yml with the following content:
    
    docker-compose.yml
    
    services:
      teslamate:
        image: teslamate/teslamate:latest
        restart: always
        environment:
          - ENCRYPTION_KEY=secretkey #replace with a secure key to encrypt your Tesla API tokens
          - DATABASE_USER=teslamate
          - DATABASE_PASS=password #insert your secure database password!
          - DATABASE_NAME=teslamate
          - DATABASE_HOST=database
          - MQTT_HOST=mosquitto
        ports:
          - 4000:4000
        volumes:
          - ./import:/opt/app/import
        cap_drop:
          - all
    
      database:
        image: postgres:16
        restart: always
        environment:
          - POSTGRES_USER=teslamate
          - POSTGRES_PASSWORD=password #insert your secure database password!
          - POSTGRES_DB=teslamate
        volumes:
          - teslamate-db:/var/lib/postgresql/data
    
      grafana:
        image: teslamate/grafana:latest
        restart: always
        environment:
          - DATABASE_USER=teslamate
          - DATABASE_PASS=password #insert your secure database password!
          - DATABASE_NAME=teslamate
          - DATABASE_HOST=database
        ports:
          - 3000:3000
        volumes:
          - teslamate-grafana-data:/var/lib/grafana
    
      mosquitto:
        image: eclipse-mosquitto:2
        restart: always
        command: mosquitto -c /mosquitto-no-auth.conf
        # ports:
        #   - 1883:1883
        volumes:
          - mosquitto-conf:/mosquitto/config
          - mosquitto-data:/mosquitto/data
    
    volumes:
      teslamate-db:
      teslamate-grafana-data:
      mosquitto-conf:
      mosquitto-data:
    
    
    

 2. Choose a secure encryption key that will be used to encrypt your Tesla API
    tokens (insert as ENCRYPTION_KEY).

 3. Choose your secure database password and insert it at every occurrence of
    DATABASE_PASS and POSTGRES_PASSWORD

 4. Start the docker containers with docker compose up. To run the containers in
    the background add the -d flag:
    
    docker compose up -d
    
    
    


USAGE

 1. Open the web interface http://your-ip-address:4000
 2. Sign in with your Tesla Account
 3. The Grafana dashboards are available at http://your-ip-address:3000. Log in
    with the default user admin (initial password admin) and enter a secure
    password.


UPDATE

To update the running TeslaMate configuration to the latest version, follow:
Upgrading to a new version

Edit this page

Next
Manual (Debian)
 * Requirements
 * Instructions
 * Usage
 * Update