Skip to content
Closed
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
20 changes: 3 additions & 17 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -55,23 +55,6 @@ Temporary Items
.directory
.Trash-*

# Ignore all modules except the default modules.
/modules/**
!/modules/default
!/modules/default/**
!/modules/README.md**

# Ignore changes to the custom css files but keep the sample and main.
/css/*
!/css/custom.css.sample
!/css/main.css
!/css/roboto.css
!/css/font-awesome.css

# Ignore users config file but keep the sample.
/config/*
!/config/config.js.sample

# Vim
## swap
[._]*.s[a-w][a-z]
Expand All @@ -88,3 +71,6 @@ js/positions.js
# Ignore lock files other than package-lock.json
pnpm-lock.yaml
yarn.lock

# Sensitive configuration files containing API keys and credentials
config/credentials.js
60 changes: 60 additions & 0 deletions config/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,60 @@
# MagicMirror Konfiguration

## 🔐 Sicherheits-Setup

### Credentials einrichten

Die sensiblen Daten (API-Keys, Passwörter) sind **nicht** in diesem Repository enthalten.

**Erstmalige Einrichtung:**

1. Kopiere die Vorlage:
```bash
cd config
cp credentials.example.js credentials.js
```

2. Öffne `credentials.js` und trage deine echten Credentials ein

3. **Wichtig:** Die Datei `credentials.js` wird automatisch von Git ignoriert!

### Benötigte API-Keys

- **OpenWeather API:** https://openweathermap.org/api
- **Tankerkönig (Fuel):** https://creativecommons.tankerkoenig.de/
- **News API:** https://newsapi.org/
- **Spotify Developer:** https://developer.spotify.com/dashboard/applications

### Dateien-Übersicht

- `config.js` - Hauptkonfiguration (OHNE sensible Daten)
- `credentials.js` - Deine persönlichen API-Keys (**NICHT in Git**)
- `credentials.example.js` - Vorlage für neue Installationen (**IN Git**)

## 📝 Konfiguration anpassen

Die Hauptkonfiguration befindet sich in `config.js`. Hier kannst du Module, Positionen, Update-Intervalle und mehr anpassen.

### Standort ändern

Die Standort-Koordinaten sind in `config.js` unter `locationSettings` definiert:

```javascript
const locationSettings = {
latitude: 51.100411,
longitude: 6.811775,
city: "Dormagen",
agsCode: "051620004004" // AGS Code für NINA Warnungen
};
```

### Module aktivieren/deaktivieren

Kommentiere Module in der `modules`-Array aus oder entferne den Kommentar, um sie zu aktivieren.

## ⚠️ Wichtige Sicherheitshinweise

1. **NIEMALS** die Datei `credentials.js` ins Git-Repository committen!
2. Teile deine API-Keys nicht öffentlich
3. Überprüfe die `.gitignore` Datei, bevor du pushst
4. Bei Problemen: Überprüfe, ob `config/credentials.js` in `.gitignore` steht
Loading
Loading