diff --git a/README.md b/README.md index 629f1999..352d4905 100644 --- a/README.md +++ b/README.md @@ -1,41 +1,41 @@ -# Django Wake on LAN -
-

A simple wake on lan app written with Django, Django-Channels (websockets), Celery and Redis.

+

A simple wake on lan app written with Django, Django-Channels (websockets), Celery, Redis and nmap.

| Dark | Light | | -------------------- | --------------------- | -| ![](https://raw.githubusercontent.com/seriousm4x/django-wake-on-lan/master/assets/dark.png) | ![](https://raw.githubusercontent.com/seriousm4x/django-wake-on-lan/master/assets/light.png) | +| ![](https://raw.githubusercontent.com/seriousm4x/django-wake-on-lan/master/assets/front-dark.png) | ![](https://raw.githubusercontent.com/seriousm4x/django-wake-on-lan/master/assets/front-light.png) | +| ![](https://raw.githubusercontent.com/seriousm4x/django-wake-on-lan/master/assets/settings-dark.png) | ![](https://raw.githubusercontent.com/seriousm4x/django-wake-on-lan/master/assets/settings-light.png) | +| ![](https://raw.githubusercontent.com/seriousm4x/django-wake-on-lan/master/assets/schedule-dark.png) | ![](https://raw.githubusercontent.com/seriousm4x/django-wake-on-lan/master/assets/schedule-light.png) | -## Features +## ✨ Features -* Simple dashboard for waking up devices on local network -* Visual indicators for device up/down and open ports. Pulse effect to visualize incoming websocket messages. -* Schedule wake events +* Dashboard to wake up devices on with 1 click +* Set date and time to schedule a wake event +* Open port scan for VNC, RDP and SSH +* Visualization of incoming websocket messages * Notifications on status changes -* Restful pings. Devices only get pinged when there are 1 or more visitors +* Devices only get pinged when there are 1 or more visitors * Dark/light mode via preferes-color-scheme -* Multithread support for pings -* Settings page with system infos +* Settings page to add/delete device and show system infos * [Docker images](https://hub.docker.com/r/seriousm4x/django-wol) for amd64, arm64, arm/v7 -## Run your own instance +## 🐳 Run your own instance You can use the example [docker-compose.yml](docker-compose.yml) file and just run `docker-compose up -d`. -## Available Env Vars +## 🔧 Available Env Vars | env var | type | info | |---------|------|------| -| DJANGO_SUPERUSER_USER | Str | Django username for /admin backend | -| DJANGO_SUPERUSER_PASSWORD | Str | Django password for /admin backend | -| DJANGO_SECRET_KEY | Str | Django secrect key. You can create your own by running `docker exec wol_django bash -c "python manage.py shell -c 'from django.core.management import utils; print(utils.get_random_secret_key())'"` | +| DJANGO_SUPERUSER_USER | Str | Username for /admin backend | +| DJANGO_SUPERUSER_PASSWORD | Str | Password for /admin backend | +| DJANGO_SECRET_KEY | Str | You can create your own by running `docker exec wol_django bash -c "python manage.py shell -c 'from django.core.management import utils; print(utils.get_random_secret_key())'"` | | DJANGO_DEBUG | Bool | Sets django to run in debug mode | | DJANGO_LANGUAGE_CODE | Str | Language code in RFC 3066 (e.g. "en-us" or "de") | | DJANGO_TIME_ZONE | Str | e.g. Europe/Berlin | @@ -46,11 +46,6 @@ You can use the example [docker-compose.yml](docker-compose.yml) file and just r | PING_INTERVAL | Int | Time between pings | | ENABLE_NOTIFICATIONS | Bool | Show notifications in the bottom right corner | - -## Manage devices - -Adding devices is (for now) only possible via the /admin backend. A frontend solution will be implemented in the future. - -## Other infos +## 📝 Other infos * The django container needs to run in host network mode to send the wakeonlan command on your local network. Therefore all other containers also need to run in host network mode. I don't like it but there is no way around. diff --git a/assets/dark.png b/assets/dark.png deleted file mode 100644 index 155e591d..00000000 Binary files a/assets/dark.png and /dev/null differ diff --git a/assets/font-dark.png b/assets/font-dark.png new file mode 100644 index 00000000..42948600 Binary files /dev/null and b/assets/font-dark.png differ diff --git a/assets/front-light.png b/assets/front-light.png new file mode 100644 index 00000000..7f0dda7e Binary files /dev/null and b/assets/front-light.png differ diff --git a/assets/light.png b/assets/light.png deleted file mode 100644 index 1b73a4d4..00000000 Binary files a/assets/light.png and /dev/null differ diff --git a/assets/schedule-dark.png b/assets/schedule-dark.png new file mode 100644 index 00000000..ebfa2b10 Binary files /dev/null and b/assets/schedule-dark.png differ diff --git a/assets/schedule-light.png b/assets/schedule-light.png new file mode 100644 index 00000000..67a59246 Binary files /dev/null and b/assets/schedule-light.png differ diff --git a/assets/settings-dark.png b/assets/settings-dark.png new file mode 100644 index 00000000..eec63750 Binary files /dev/null and b/assets/settings-dark.png differ diff --git a/assets/settings-light.png b/assets/settings-light.png new file mode 100644 index 00000000..0597e981 Binary files /dev/null and b/assets/settings-light.png differ