update screenshots and features
39
README.md
@@ -1,41 +1,41 @@
|
||||
# Django Wake on LAN
|
||||
|
||||
<div align="center" width="100%">
|
||||
<img src="app/wol/static/img/favicon.png" width="128" />
|
||||
</div>
|
||||
|
||||
<div align="center" width="100%">
|
||||
<p>A simple wake on lan app written with Django, Django-Channels (websockets), Celery and Redis.</p>
|
||||
<p>A simple wake on lan app written with Django, Django-Channels (websockets), Celery, Redis and nmap.</p>
|
||||
<a target="_blank" href="https://github.com/seriousm4x/django-wake-on-lan"><img src="https://img.shields.io/github/stars/seriousm4x/django-wake-on-lan" /></a> <a target="_blank" href="https://hub.docker.com/r/seriousm4x/django-wol"><img src="https://img.shields.io/docker/pulls/seriousm4x/django-wol" /></a> <a target="_blank" href="https://hub.docker.com/r/seriousm4x/django-wol"><img src="https://img.shields.io/docker/v/seriousm4x/django-wol/latest?label=docker%20image%20ver." /></a> <a target="_blank" href="https://github.com/seriousm4x/django-wake-on-lan"><img src="https://img.shields.io/github/last-commit/seriousm4x/django-wake-on-lan" /></a>
|
||||
</div>
|
||||
|
||||
| Dark | Light |
|
||||
| -------------------- | --------------------- |
|
||||
|  |  |
|
||||
|  |  |
|
||||
|  |  |
|
||||
|  |  |
|
||||
|
||||
## 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.
|
||||
|
||||
BIN
assets/dark.png
|
Before Width: | Height: | Size: 134 KiB |
BIN
assets/font-dark.png
Normal file
|
After Width: | Height: | Size: 158 KiB |
BIN
assets/front-light.png
Normal file
|
After Width: | Height: | Size: 166 KiB |
BIN
assets/light.png
|
Before Width: | Height: | Size: 136 KiB |
BIN
assets/schedule-dark.png
Normal file
|
After Width: | Height: | Size: 42 KiB |
BIN
assets/schedule-light.png
Normal file
|
After Width: | Height: | Size: 43 KiB |
BIN
assets/settings-dark.png
Normal file
|
After Width: | Height: | Size: 158 KiB |
BIN
assets/settings-light.png
Normal file
|
After Width: | Height: | Size: 158 KiB |