Commit Graph

13 Commits

Author SHA1 Message Date
JakobLichterfeld
27e2ea1a8f docs: streamline installation guides (#4829)
* docs: remove manual installation reference from docker setup

* docs: update changelog

* docs: add nix develop to run treefmt to support non nix direnv users

* docs: update changelog

* docs: add Unraid installation and maintenance instructions (no support)

* docs: clarify the use of secure connection to access TeslaMate

* docs: reorder guides into advanced guides, categories FleetAPI documentation as config

* docs: clarify which installation methods are supported and which are not

* chore(issue-template): update bug report template to include Unraid as unsupported installation method

* docs: fix sidebars link

* docs: state in title which installation method is not supported

* docs: nested entry for unsupported installation methods

* docs: nest unsupported installation methods in separate folder for even more clarity

* docs: fix links

* docs: mention dedicated version for MCU2 upgraded cars
2025-07-21 13:46:20 +02:00
JakobLichterfeld
274a8ffde9 docs: add NixOS installation guide (#4768)
* docs: add NixOS installation guide

* docs: update changelog

* docs: add reverse proxy configuration for TeslaMate with Caddy

* docs: update NixOS installation guide for secure connection recommendations
2025-05-29 09:22:04 +02:00
JakobLichterfeld
6e3a5164da docs: show screenshots entry in sidebar (#4602)
* docs: show screenshots entry in sidebar

* docs: add screenshots entry to sidebar
2025-04-04 11:48:18 +02:00
JakobLichterfeld
fdf8185ce2 ci: add treefmt as code formatting multiplexer, refactor CI to avoid duplication, reorg CI into DevOps workflow (#4219)
* ci: add treefmt as code formatting multiplexer

* style: linter findings in entrypoint.sh script

* style: linter findings for yaml and yml

* style: linter findings for json files

* style: linter findings for nix files

* style: linter findings for js files

* style: linter findings for dashboards.sh

* style: linter findings for md and mdx files

* chore: remove unused clang formatter in treefmt config

* style: linter findings for mdx files

* ci: exclude Grafana dashboard JSON files from prettier formatting

* Revert "style: linter findings for json files"

This reverts commit f40c2e1759.

* ci: exclude Grafana dashboard JSON files from all formatting as we use the grafana export style

* style: linter findings for json files

* doc: update changelog

* ci(refactor): use composite action to avoid duplication in elixir workflow

* doc: update changelog

* ci: prevent workflow runs for certain conditions and allow scheduled runs

* ci(refactor): use reusable workflow to check paths

* ci(fix): correct output syntax for check_paths workflow and setting base branch

* ci(refactor): use reusable workflows for streamlined DevOps pipeline

* ci(fix): add write permission for packages in DevOps workflow

* ci(test): test DevOps workflow

* ci(test): test DevOps workflow

* ci(fix): Update condition for spell_check, ensure_linting, elixir, and ghcr_build workflows to reflect empty result instead of false

* ci: revert test DevOps

* ci(refactor): allow ghcr_build parallel to elixir test

* ci(refactor): Remove redundant check_paths job from elixir.yml, elixir_test.yml, and spell_check.yml workflows, check is done in devops.yml

* feat: add treefmt-nix to nix flake (#4219 - @JakobLichterfeld)

* ci: ensure proper linting via treefmt

* ci(test): test ensure_linting workflow

* ci(fix): checkout code for spell_checker to access file to check

* ci(fix): allow impure in ensure_linting workflow

* Revert "ci(test): test ensure_linting workflow"

This reverts commit a67b17ec09.

* ci(fix): correct use of flake-utils for formatter and checks

Co-authored-by: scottbot95 <scottbot95@gmail.com>

* ci(fix): correct use of flake-utils for treefmt

Co-authored-by: scottbot95 <scottbot95@gmail.com>

* refactor: Remove unnecessary imports in flake

* ci(fix): correct syntax in flake

* ci(refactor): Remove unused code in flake.nix

* style: standardised style for input url in flake

* ci(fix): treefmt-nix config with existing options

* ci(feat): Add Nix binary cache and update treefmt command in CI workflow

* ci(refactor): Remove unused code in flake.nix

* fix: include devShell packages only on supported platforms

* fix: update hash for mix-deps package in flake.nix

* ci(fix): Update treefmt command in CI workflow

* ci(test): test ensure_linting workflow

* feat: ensure mix deps are present in devShell

* ci(feat): use flake-parts to enable treefmt-nix

* feat: use flake-parts

* fix: correct use of flake-parts for package build

* doc: update CI badge URL for devops workflow

* ci(fix): handle empty path filter output

* ci: remove --impure flag from treefmt command in CI workflow

* fix: correct treefmt.config settings in formatter.nix

* fix: correct flake-parts inputs, avoid with in imports

* fix: correct program name for mix-format in formatter.nix

* feat: devenv via flake-parts

* fix: correct use of legacy nix code with flake-parts

* ci(fix): correct nix develop command in ensure_linting.yml

* refactor: list imports explicitly in flake, rename folder to flake-modules to be precise

* style: use tabs for indent size to format sh

* style: use nixfmt-rfc-style

* Revert "style: use nixfmt-rfc-style"

This reverts commit 082056159e.

* style: use nixfmt style

* fix: remove glibcLocales from optional dependencies to avoid  "A definition for option `packages."[definition 4-entry 16]"' is not of type `package'."

* fix: remove inotify-tools from optional dependencies to avoid  "A definition for option `packages."[definition 4-entry 16]"' is not of type `package'."

* fix: Remove inotify-tools and glibcLocales from optional dependencie

* fix: correct file paths in flake.nix to version

* fix: add ELIXIR_ERL_OPTIONS to shell environment to force utf8 locale

* fix: add LOCALE_ARCHIVE to shell environment in flake.nix

* Revert "fix: add LOCALE_ARCHIVE to shell environment in flake.nix"

This reverts commit d45f6e32ee.

* ci(refactor): rename workflow to elixir_dep_verification_and_static_analysis.yml to better reflect the intention,, remove duplicate checks

* ci(debug): debug locale settings

* Revert "ci(debug): debug locale settings"

This reverts commit 9b402f3c5f.

* Revert "fix: add ELIXIR_ERL_OPTIONS to shell environment to force utf8 locale"

This reverts commit d02419cba4.

* fix: add LOCALE_ARCHIVE to shell environment in flake.nix

* Revert "fix: add LOCALE_ARCHIVE to shell environment in flake.nix"

This reverts commit 761b437e69.

* fix: add LANG=C.UTF-8 to shell environment in flake.nix

* fix: add mix local.rebar and mix local.hex commands to flake.nix

* fix: pin devenv to version without unix socket bug

* chore: update nixpkgs to nixos-24.05 and update dependencies

* doc: add treefmt config comments

* ci: do not expose treefmt formatter programs in devshell

* fix: correct use of module option to enable PostgreSQL server in flake.nix

* Revert "chore: update nixpkgs to nixos-24.05 and update dependencies"

This reverts commit a6ea3f25aa.

* feat: consistent use of erlang 26 and elixir 1_16 in flake

* ci: switch to macOS runner for linting workflow

* Revert "ci: do not expose treefmt formatter programs in devshell"

This reverts commit 1ecfa451dc.

* Revert "ci: switch to macOS runner for linting workflow"

This reverts commit 7b430667d8.

* ci: Remove nixpkgs channel specification in ensure_linting workflow

* ci(debug): Add debug output for PATH and NIX_PATH in flake.nix

* Revert "ci(debug): Add debug output for PATH and NIX_PATH in flake.nix"

This reverts commit 07faec5ddf.

* fix: avoid the need for impure for devenv

see #4245

* fix: remove invalid custom build.check for formatter and use default

* style: linter findings

* fix: Add emptyTest to avoid nix flake check test execution on non-Linux systems

* chore: Remove LANG=C.UTF-8 from enterShell in flake.nix

* ci(fix): Remove --impure flag from treefmt command in CI mode

* ci(fix): avoid impure mode in ensure_linting workflow

* style: linter findings

* ci(debug): debug elixir version and locale

* chore: Update flake.lock dependencies

* feat: use newer devenv as unix socket bug is fixed in upstream

https://github.com/cachix/devenv/issues/1497

* fix: set rebar3 path in devenv

* Revert "ci(debug): debug elixir version and locale"

This reverts commit 7ecdc77c16.

* ci: re-enable path check in DevOps workflow

* doc: update Development and Contributing guide with nix and treefmt

* ci: use PostgreSQL 17

* style: linter findings

* ci(fix): ensure cache name in build action does not contain invalid characters to avoid invalid reference format

* doc: update changelog

* Revert "ci(fix): ensure cache name in build action does not contain invalid characters to avoid invalid reference format"

This reverts commit 02abb0359d.

* ci: remove branch restriction for check_paths workflow to increase sec

* ci(fix): run ghcr build workflow only for specific conditions

- Ensure workflow only run if there are no changes to the .github folder
- Allow workflow to run on workflow call or PRs from forks
- Prevent duplicate runs for PRs from non-forks
- Avoid invalid reference format for cache name in PRs from our repository

* doc: update changelog

* fix: update hash for mix-deps package in flake.nix

* fix: disable flakeCheck for formatter, as mix format need the dep to be fetched beforehand

* ci(fix): run ghcr build workflow only for specific conditions

* fix: move nixosModules.default to top-level attribute set

* refactor: remove unnecessary config nesting in formatter.nix

* ci(fix): ensure version for buildx is set to correct name

---------

Co-authored-by: scottbot95 <scottbot95@gmail.com>
2024-10-14 08:54:10 +02:00
jlestel
2ca545aea3 doc: Documentation for new endpoint changes (#3978)
* Update docs

* Update for streaming

* Update guides and add a reference in the project page

* Update for readability

* readability

* format

* update fleet api price

* Update direct Tesla API part

---------

Co-authored-by: Julien <julien@citio.digital>
2024-07-02 15:47:29 +02:00
JakobLichterfeld
eaa518d8a5 doc: remove outdated, unsupported, unmaintained portainer doc (#3972)
* doc:remove outdated, unmaintained portainer doc

* doc: Remove unmaintained Portainer documentation

* doc: update changelog
2024-06-18 19:01:49 +02:00
PhracturedBlue
3cc0102090 Support listening on unix domain socket (#3328)
* Support connection on unix domain socket

* Better support for unix domain sockets

* Document Unix Domain sockets

* Fix typos caught by review
2024-01-29 13:43:45 +01:00
Peter Boothby
1f8bbef39a Integration Guide for Node-RED, with examples (#2098)
* Create Node-RED.md

* Update Node-RED.md

* Add files via upload

* Update Node-RED.md

* Update Node-RED.md

* Add files via upload

* Update Node-RED.md

* Update Node-RED.md

* Add files via upload

* Update Node-RED.md

* Update Node-RED.md

* Update Node-RED.md

* Update Node-RED.md

* Update Node-RED.md

* Update Node-RED.md

* Update Node-RED.md

* Update Node-RED.md

* Update Node-RED.md

* Add files via upload

* Update Node-RED.md

* Create Node-RED.md

* Add files via upload

* Update Node-RED.md

* Update Node-RED.md

* Add files via upload

* Update Node-RED.md

* Update Node-RED.md

improved the directions for adding node-red modules

* Add sidebar link

* Format markdown file

* Fix file link

* Move assets into separate directory

* Optimize images

* fix spelling error

"hamburber" sounds like something Donald Trump would write. I fixed the spelling error. :)

Co-authored-by: Adrian Kumpf <8999358+adriankumpf@users.noreply.github.com>
2021-11-08 17:05:36 +01:00
Iulius
493177571f Documentation update: FreeBSD added (#1646)
* Create freebsd.md

Basic instruction how to install Teslamate on FreeBSD

* Small adjustments necessary for FreeBSD reflected

* Add empty line before closing tag

* Add FreeBSD guide to the sidebar

* Move FreeBSD upgrade instruction into separate tab

Co-authored-by: Adrian Kumpf <8999358+adriankumpf@users.noreply.github.com>
2021-06-04 12:04:04 +02:00
Adrian Kumpf
e649a2c2dd Add a page that lists projects that use TeslaMate 2020-07-01 15:09:08 +02:00
DrMichael
4288e187c8 Add portainer to the documentation (#581)
* Create portainer

Created portainer installation description.

* Update portainer

* Update sidebars.js

Added portainer

* Rename portainer to portainer.md

* Update portainer.md

* Fix JSX syntax errors

Co-authored-by: Adrian Kumpf <adrian.kumpf@posteo.de>
2020-04-14 11:51:47 +02:00
Adrian Kumpf
adca2fc4f4 Update docs 2020-04-11 16:07:09 +02:00
Adrian Kumpf
c6b265788c Migrate docs to docusaurus
Fixes #564
2020-04-07 19:32:18 +02:00