62191b21b8
> Version 0.6 brings DashMachine one big step forward to being a finished product by adding a gui to edit the various settings in the config.ini. **Changelog** - improvements to /home including 'pinned' cards, multi-select tag filtering, 'action providers' allowing you to do web searches from the searchbar - rebuilt sidenav with list view, mirroring filter/search/collapse state of the homepage - /settings and /home now on same route - dynamic reloading of settings (no more page reloads) - dedicated config.ini editor slide-out - settings editor slide-out - card editor slide-out - better access group control - dedicated documentation pages - improved documentation - new system for automatically generating documentation for platforms - ability to load custom platforms - added an 'on_starup' method for platforms allowing for registering api routes. (example coming soon)
56 lines
1.5 KiB
Markdown
56 lines
1.5 KiB
Markdown
# Installation
|
|
### Default user/password
|
|
```
|
|
User: admin
|
|
Password: admin
|
|
```
|
|
### Docker
|
|
```bash
|
|
docker create \
|
|
--name=dashmachine \
|
|
-p 5000:5000 \
|
|
-v path/to/data:/dashmachine/dashmachine/user_data \
|
|
--restart unless-stopped \
|
|
rmountjoy/dashmachine:latest
|
|
```
|
|
To run in a subfolder, use a CONTEXT_PATH environment variable. For example, to run at localhost:5000/dash:
|
|
|
|
```bash
|
|
docker create \
|
|
--name=dashmachine \
|
|
-p 5000:5000 \
|
|
-e CONTEXT_PATH=/dash
|
|
-v path/to/data:/dashmachine/dashmachine/user_data \
|
|
--restart unless-stopped \
|
|
rmountjoy/dashmachine:latest
|
|
```
|
|
### Docker Compose
|
|
|
|
```yaml
|
|
version: "2"
|
|
services:
|
|
dashmachine:
|
|
image: rmountjoy/dashmachine:latest
|
|
container_name: dashmachine
|
|
restart: unless-stopped
|
|
environment:
|
|
- CONTEXT_PATH: /dash #Optional, only if you want to run dashmachine in a subfolder
|
|
volumes:
|
|
- /path/to/data:/dashmachine/dashmachine/user_data
|
|
ports:
|
|
- 5000:5000 #You can change the port on the left (host) it's already in use, e.g. Synology NAS
|
|
```
|
|
|
|
### Synology
|
|
* [Check out this awesome guide](https://nashosted.com/manage-your-self-hosted-applications-using-dashmachine/)
|
|
|
|
### Python
|
|
Instructions are for linux.
|
|
```bash
|
|
virtualenv --python=python3 DashMachineEnv
|
|
cd DashMachineEnv && source bin/activate
|
|
git clone https://github.com/rmountjoy92/DashMachine.git
|
|
cd DashMachine && pip install -r requirements.txt
|
|
python3 run.py
|
|
```
|
|
Then open a web browser and go to localhost:5000 |