mirror of
https://github.com/Casvt/MIND.git
synced 2026-02-19 11:54:46 -05:00
Added installation and post-installation docs
This commit is contained in:
@@ -15,9 +15,11 @@ General Information:
|
||||
- [API Docs](./api.md)
|
||||
|
||||
## Workings
|
||||
|
||||
MIND can be used for sending notifications at the desired time. This can be a set time, like a yearly reminder for a birthday, or at a button click, to easily send a predefined notification when you want to.
|
||||
|
||||
## Features
|
||||
|
||||
- Works cross-timezone
|
||||
- Notifications are sent with second-precision
|
||||
- Uses the [apprise library](https://github.com/caronc/apprise), giving you 80+ platforms to send notifications to
|
||||
@@ -27,8 +29,10 @@ MIND can be used for sending notifications at the desired time. This can be a se
|
||||
- API available
|
||||
|
||||
### Planned Features
|
||||
|
||||
You can see the planned features in the [Project board](https://github.com/users/Casvt/projects/3).
|
||||
|
||||
## Contact
|
||||
|
||||
- For support, a [discord server](https://discord.gg/nMNdgG7vsE) is available
|
||||
- Alternatively, [make an issue](https://github.com/Casvt/MIND/issues)
|
||||
|
||||
@@ -1,3 +1,83 @@
|
||||
# Installation
|
||||
|
||||
Coming soon
|
||||
The recommended way to install MIND is using Docker. After installing MIND, it is advised to read the [Setup After Installation page](setup_after_installation.md).
|
||||
|
||||
NOTE: Make sure to set all time related settings (time, date, timezone, etc.) correct on your computer, as MIND depends on it to work correctly.
|
||||
|
||||
## Docker
|
||||
|
||||
=== "Docker CLI"
|
||||
The command to get the docker container running can be found below. Replace the timezone value (`TZ=`) to the [TZ database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) of your timezone.
|
||||
```bash
|
||||
docker run -d \
|
||||
--name mind \
|
||||
-v mind-db:/app/db \
|
||||
-e TZ=Europe/Amsterdam \
|
||||
-p 8080:8080 \
|
||||
mrcas/mind:latest
|
||||
```
|
||||
=== "Docker Compose"
|
||||
The contents of the `docker-compose.yml` file would look like below. Replace the timezone value (`TZ=`) to the [TZ database name](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) of your timezone.
|
||||
```yml
|
||||
version: '3.3'
|
||||
services:
|
||||
mind:
|
||||
container_name: mind
|
||||
volumes:
|
||||
- 'mind-db:/app/db'
|
||||
environment:
|
||||
- TZ=Europe/Amsterdam
|
||||
ports:
|
||||
- '8080:8080'
|
||||
image: 'mrcas/mind:latest'
|
||||
```
|
||||
|
||||
Information on how to change the port can be found on the [Setup After Installation page](setup_after_installation.md#port).
|
||||
|
||||
Using a named volume in docker requires you to create the volume before you can use it (see [Named Volumes](#named-volumes)).
|
||||
|
||||
### Named Volumes
|
||||
|
||||
=== "Docker CLI"
|
||||
```bash
|
||||
docker volume create mind-db
|
||||
```
|
||||
|
||||
=== "Portainer"
|
||||
- Open `Volumes`
|
||||
- Click `Add Volume`
|
||||
- Enter name matching the one you'll use in compose (`mind-db`, in the above provided command)
|
||||
- Click `Create the volume`
|
||||
- Open `Stacks`
|
||||
- Create the stack with the named volume in it.
|
||||
|
||||
Both of these options will create a named volume that you can then use in the command above.
|
||||
If you'd prefer to use a local folder on the host machine for storing config, Linux standards would suggest putting that in `/opt/application_name`, as the `/opt` directory is where program options should be stored.
|
||||
In this case, you'd create the desired folder with something like `mkdir /opt/MIND/db`, and replace 'mind-db:/app/db' with '/opt/MIND/db:/app/db'.
|
||||
|
||||
## Manual Install
|
||||
|
||||
See below for installation instructions for your OS if you want to install it manually.
|
||||
|
||||
=== "Linux / MacOS"
|
||||
```bash
|
||||
sudo apt-get install git python3-pip
|
||||
sudo git clone https://github.com/Casvt/MIND.git /opt/MIND
|
||||
cd /opt/MIND
|
||||
python3 -m pip install -r requirements.txt
|
||||
python3 MIND.py
|
||||
```
|
||||
=== "Windows"
|
||||
1. Install python [in the Microsoft Store](https://www.microsoft.com/store/productId/9PJPW5LDXLZ5)
|
||||
2. Install pip [using these instructions](https://www.liquidweb.com/kb/install-pip-windows/)
|
||||
3. Download [the latest release](https://github.com/Casvt/MIND/zipball/master)
|
||||
4. Extract the ZIP file
|
||||
5. With the folder open, right click and select `Open in Terminal`
|
||||
6. Type the following command:
|
||||
```bash
|
||||
python3 -m pip install -r requirements.txt
|
||||
```
|
||||
7. Type the following command:
|
||||
```bash
|
||||
python3 MIND.py
|
||||
```
|
||||
|
||||
@@ -1,3 +1,24 @@
|
||||
# Setup After Installation
|
||||
|
||||
Coming Soon
|
||||
After installing MIND, you should have access to the web-ui. MIND needs some configuration in order for it to work properly.
|
||||
|
||||
## Port
|
||||
|
||||
The first thing to do is decide if you want to leave MIND running on the default port of `8080`. If you _do_, you can go to the next step. If you want to _change_ the port, continue reading.
|
||||
|
||||
=== "Docker CLI"
|
||||
Alter the command to run the container and replace `-p 8080:8080` with `-p {PORT}:8080`, where `{PORT}` is the desired port (e.g. `-p 8009:8080`). Then run the container with the new version of the command.
|
||||
|
||||
=== "Docker Compose"
|
||||
Alter the file to run the container and replace `- 8080:8080` with `- {PORT}:8080`, where `{PORT}` is the desired port (e.g. `- 8009:8080`). Then run the container with the new version of the file.
|
||||
|
||||
=== "Manual Install"
|
||||
Inside the `MIND.py` file at the top, you can set the port via the `PORT` variable. Change it from `PORT = '8080'` to `PORT = '{PORT}'`, where `{PORT}` is the desired port (e.g. `PORT = '8009'`). Then restart the application.
|
||||
|
||||
## Creating an account
|
||||
|
||||
When accessing the web-ui, you'll be prompted to log in. Click on `Or create an account`, enter the desired username and password for the account and click `Create`. The account is created and can now be logged in with. The complete authentication process is local and no data is shared with any other service.
|
||||
|
||||
## Add a notification service
|
||||
|
||||
A notification service is a way of sending a notification. For example an e-mail to a group of people or a PushBullet notification to a specific device. What the actual content of the notification is, is decided by the title and text of the reminder. The notification service only specifies in which way the title and text is sent. You set it up once, and then you can select it when creating a reminder. A notification service consists of a title (name) and an Apprise URL. See the [Apprise URL documentation](https://github.com/caronc/apprise#supported-notifications) to learn how to make a valid Apprise URL.
|
||||
|
||||
Reference in New Issue
Block a user