Skip to content

Commit

Permalink
doc: typo and style for docker compose v2 notes
Browse files Browse the repository at this point in the history
  • Loading branch information
JakobLichterfeld committed Nov 21, 2023
1 parent 1796294 commit 03d5e43
Show file tree
Hide file tree
Showing 3 changed files with 10 additions and 7 deletions.
4 changes: 2 additions & 2 deletions website/docs/maintenance/backup_restore.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
title: Backup and Restore
---
:::note
If you are using `docker-compose`, you are using Docker Compose v1 and has become end of life. Docker Compse commands reference Docker Compose v2. Consider upgrading https://docs.docker.com/compose/migrate/
If you are using `docker-compose`, you are using Docker Compose v1, which has been deprecated. Docker Compose commands refer to Docker Compose v2. Consider upgrading your docker setup, see [Migrate to Compose V2](https://docs.docker.com/compose/migrate/)
:::

## Backup
Expand All @@ -26,7 +26,7 @@ If you get the error `No such service: database`, update your _docker-compose.ym
:::

:::note
If you changed `TM_DB_USER` in the .env file from one of the advanced guides, make sure to replace the first instance of `teslamate` to the value of `TM_DB_USER` in the above command.
If you changed `TM_DB_USER` in the .env file from one of the advanced guides, make sure to replace the first instance of `teslamate` to the value of `TM_DB_USER` in the above command.
:::

## Restore
Expand Down
4 changes: 3 additions & 1 deletion website/docs/maintenance/manually_fixing_data.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -2,8 +2,9 @@
title: Manually fixing data
---
:::note
If you are using `docker-compose`, you are using Docker Compose v1 and has become end of life. Docker Compse commands reference Docker Compose v2. Consider upgrading https://docs.docker.com/compose/migrate/
If you are using `docker-compose`, you are using Docker Compose v1, which has been deprecated. Docker Compose commands refer to Docker Compose v2. Consider upgrading your docker setup, see [Migrate to Compose V2](https://docs.docker.com/compose/migrate/)
:::

## Get the ID

First you need to find out the ID of the drive or charge:
Expand Down Expand Up @@ -104,6 +105,7 @@ If for some reason a drive or charge was recorded incorrectly, you can delete it
</Tabs>

## Remove a vehicle from the database

**NOTE:** Always [backup](https://docs.teslamate.org/docs/maintenance/backup_restore "backup") your data before performing any database changes.

1. Connect to your TeslaMate database
Expand Down
9 changes: 5 additions & 4 deletions website/docs/upgrading.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ Check out the [release notes](https://github.com/teslamate-org/teslamate/release

:::note
Create a [backup](maintenance/backup_restore.md) before updating.
If you are using `docker-compose`, you are using Docker Compose v1 and has become end of life. Docker Compse commands reference Docker Compose v2. Consider upgrading https://docs.docker.com/compose/migrate/
If you are using `docker-compose`, you are using Docker Compose v1, which has been deprecated. Docker Compose commands refer to Docker Compose v2. Consider upgrading your docker setup, see [Migrate to Compose V2](https://docs.docker.com/compose/migrate/)
:::

import Tabs from "@theme/Tabs";
Expand Down Expand Up @@ -58,8 +58,9 @@ docker compose up -d
```bash
_build/prod/rel/teslamate/bin/teslamate eval "TeslaMate.Release.migrate"
```

Note, you may need to include environment variables when running this step:

```bash
DATABASE_USER=teslamate DATABASE_PASS=super_secret_password DATABASE_NAME=teslamate DATABASE_HOST=localhost MQTT_HOST=your_MQTT_host(HomeAssistant in my case) _build/prod/rel/teslamate/bin/teslamate eval "TeslaMate.Release.migrate"
```
Expand Down Expand Up @@ -94,9 +95,9 @@ docker compose up -d
```bash
_build/prod/rel/teslamate/bin/teslamate eval "TeslaMate.Release.migrate"
```

Note: you may need to include environment variables as part of this step:

```bash
DATABASE_USER=teslamate DATABASE_PASS=super_secret_password DATABASE_NAME=teslamate DATABASE_HOST=localhost MQTT_HOST=your_MQTT_host(HomeAssistant in my case) _build/prod/rel/teslamate/bin/teslamate eval "TeslaMate.Release.migrate"
```
Expand Down

0 comments on commit 03d5e43

Please sign in to comment.