github/MIND
1
1
Fork 0
mirror of https://github.com/Casvt/MIND.git synced 2026-02-19 11:54:46 -05:00
Code Issues Packages Projects Releases Wiki Activity
Files
gh-pages
MIND/installation/docker/index.html

1406 lines
46 KiB
HTML
Raw Permalink Blame History

<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<meta name="description" content="The official guide for MIND">
<meta name="author" content="Casvt">
<link rel="prev" href="../installation/">
<link rel="next" href="../manual_instal/">
<link rel="icon" href="../../assets/img/favicon.svg">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.6.19">
<title>Docker - MIND Docs</title>
<link rel="stylesheet" href="../../assets/stylesheets/main.7e37652d.min.css">
<link rel="stylesheet" href="../../assets/stylesheets/palette.06af60db.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
<link rel="stylesheet" href="../../css/timeago.css">
<link rel="stylesheet" href="../../assets/css/extra.css">
<script>__md_scope=new URL("../..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
</head>
<body dir="ltr" data-md-color-scheme="MIND" data-md-color-primary="indigo" data-md-color-accent="indigo">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#installation" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header md-header--shadow md-header--lifted" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href="../.." title="MIND Docs" class="md-header__button md-logo" aria-label="MIND Docs" data-md-component="logo">
<img src="../../assets/img/favicon.svg" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
MIND Docs
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Docker
</span>
</div>
</div>
</div>
<form class="md-header__option" data-md-component="palette">
<input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="MIND" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_0">
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_1" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M17 6H7c-3.31 0-6 2.69-6 6s2.69 6 6 6h10c3.31 0 6-2.69 6-6s-2.69-6-6-6m0 10H7c-2.21 0-4-1.79-4-4s1.79-4 4-4h10c2.21 0 4 1.79 4 4s-1.79 4-4 4M7 9c-1.66 0-3 1.34-3 3s1.34 3 3 3 3-1.34 3-3-1.34-3-3-3"/></svg>
</label>
<input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="MIND-dark" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_1">
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_0" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M17 7H7a5 5 0 0 0-5 5 5 5 0 0 0 5 5h10a5 5 0 0 0 5-5 5 5 0 0 0-5-5m0 8a3 3 0 0 1-3-3 3 3 0 0 1 3-3 3 3 0 0 1 3 3 3 3 0 0 1-3 3"/></svg>
</label>
</form>
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
</button>
</nav>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
<div class="md-header__source">
<a href="https://github.com/Casvt/MIND" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 7.0.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path fill="currentColor" d="M439.6 236.1 244 40.5c-5.4-5.5-12.8-8.5-20.4-8.5s-15 3-20.4 8.4L162.5 81l51.5 51.5c27.1-9.1 52.7 16.8 43.4 43.7l49.7 49.7c34.2-11.8 61.2 31 35.5 56.7-26.5 26.5-70.2-2.9-56-37.3L240.3 199v121.9c25.3 12.5 22.3 41.8 9.1 55-6.4 6.4-15.2 10.1-24.3 10.1s-17.8-3.6-24.3-10.1c-17.6-17.6-11.1-46.9 11.2-56v-123c-20.8-8.5-24.6-30.7-18.6-45L142.6 101 8.5 235.1C3 240.6 0 247.9 0 255.5s3 15 8.5 20.4l195.6 195.7c5.4 5.4 12.7 8.4 20.4 8.4s15-3 20.4-8.4l194.7-194.7c5.4-5.4 8.4-12.8 8.4-20.4s-3-15-8.4-20.4"/></svg>
</div>
<div class="md-source__repository">
Casvt/MIND
</div>
</a>
</div>
</nav>
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
<div class="md-grid">
<ul class="md-tabs__list">
<li class="md-tabs__item">
<a href="../.." class="md-tabs__link">
Home
</a>
</li>
<li class="md-tabs__item md-tabs__item--active">
<a href="../installation/" class="md-tabs__link">
Installation And Updating
</a>
</li>
<li class="md-tabs__item">
<a href="../../general_info/workings/" class="md-tabs__link">
General Information
</a>
</li>
<li class="md-tabs__item">
<a href="../../settings/settings/" class="md-tabs__link">
Settings
</a>
</li>
<li class="md-tabs__item">
<a href="../../other_docs/reporting/" class="md-tabs__link">
Other Docs
</a>
</li>
</ul>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary md-nav--lifted" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href="../.." title="MIND Docs" class="md-nav__button md-logo" aria-label="MIND Docs" data-md-component="logo">
<img src="../../assets/img/favicon.svg" alt="logo">
</a>
MIND Docs
</label>
<div class="md-nav__source">
<a href="https://github.com/Casvt/MIND" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 448 512"><!--! Font Awesome Free 7.0.0 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2025 Fonticons, Inc.--><path fill="currentColor" d="M439.6 236.1 244 40.5c-5.4-5.5-12.8-8.5-20.4-8.5s-15 3-20.4 8.4L162.5 81l51.5 51.5c27.1-9.1 52.7 16.8 43.4 43.7l49.7 49.7c34.2-11.8 61.2 31 35.5 56.7-26.5 26.5-70.2-2.9-56-37.3L240.3 199v121.9c25.3 12.5 22.3 41.8 9.1 55-6.4 6.4-15.2 10.1-24.3 10.1s-17.8-3.6-24.3-10.1c-17.6-17.6-11.1-46.9 11.2-56v-123c-20.8-8.5-24.6-30.7-18.6-45L142.6 101 8.5 235.1C3 240.6 0 247.9 0 255.5s3 15 8.5 20.4l195.6 195.7c5.4 5.4 12.7 8.4 20.4 8.4s15-3 20.4-8.4l194.7-194.7c5.4-5.4 8.4-12.8 8.4-20.4s-3-15-8.4-20.4"/></svg>
</div>
<div class="md-source__repository">
Casvt/MIND
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../.." class="md-nav__link">
<span class="md-ellipsis">
Home
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--active md-nav__item--section md-nav__item--nested">
<input class="md-nav__toggle md-toggle " type="checkbox" id="__nav_2" checked>
<label class="md-nav__link" for="__nav_2" id="__nav_2_label" tabindex="">
<span class="md-ellipsis">
Installation And Updating
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_2_label" aria-expanded="true">
<label class="md-nav__title" for="__nav_2">
<span class="md-nav__icon md-icon"></span>
Installation And Updating
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../installation/" class="md-nav__link">
<span class="md-ellipsis">
Introduction
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
Docker
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Docker
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#installation" class="md-nav__link">
<span class="md-ellipsis">
Installation
</span>
</a>
<nav class="md-nav" aria-label="Installation">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#time-settings" class="md-nav__link">
<span class="md-ellipsis">
Time settings
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#instal-docker" class="md-nav__link">
<span class="md-ellipsis">
Instal Docker
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#create-docker-volume-or-folder" class="md-nav__link">
<span class="md-ellipsis">
Create Docker volume or folder
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#launch-container" class="md-nav__link">
<span class="md-ellipsis">
Launch container
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#update-instal" class="md-nav__link">
<span class="md-ellipsis">
Update instal
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../manual_instal/" class="md-nav__link">
<span class="md-ellipsis">
Manual Instal
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../setup_after_installation/" class="md-nav__link">
<span class="md-ellipsis">
Setup After Installation
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_3" >
<label class="md-nav__link" for="__nav_3" id="__nav_3_label" tabindex="0">
<span class="md-ellipsis">
General Information
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_3_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_3">
<span class="md-nav__icon md-icon"></span>
General Information
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../general_info/workings/" class="md-nav__link">
<span class="md-ellipsis">
Introduction
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../general_info/reminders/" class="md-nav__link">
<span class="md-ellipsis">
Reminders
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../general_info/admin_panel/" class="md-nav__link">
<span class="md-ellipsis">
Admin Panel
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_4" >
<label class="md-nav__link" for="__nav_4" id="__nav_4_label" tabindex="0">
<span class="md-ellipsis">
Settings
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_4_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_4">
<span class="md-nav__icon md-icon"></span>
Settings
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../settings/settings/" class="md-nav__link">
<span class="md-ellipsis">
Introduction
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../settings/user_settings/" class="md-nav__link">
<span class="md-ellipsis">
User Settings
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../settings/admin_settings/" class="md-nav__link">
<span class="md-ellipsis">
Admin Settings
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item md-nav__item--nested">
<input class="md-nav__toggle md-toggle md-toggle--indeterminate" type="checkbox" id="__nav_5" >
<label class="md-nav__link" for="__nav_5" id="__nav_5_label" tabindex="0">
<span class="md-ellipsis">
Other Docs
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<nav class="md-nav" data-md-level="1" aria-labelledby="__nav_5_label" aria-expanded="false">
<label class="md-nav__title" for="__nav_5">
<span class="md-nav__icon md-icon"></span>
Other Docs
</label>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href="../../other_docs/reporting/" class="md-nav__link">
<span class="md-ellipsis">
Reporting
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../../other_docs/api/" class="md-nav__link">
<span class="md-ellipsis">
API
</span>
</a>
</li>
</ul>
</nav>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-sidebar md-sidebar--secondary" data-md-component="sidebar" data-md-type="toc" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#installation" class="md-nav__link">
<span class="md-ellipsis">
Installation
</span>
</a>
<nav class="md-nav" aria-label="Installation">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#time-settings" class="md-nav__link">
<span class="md-ellipsis">
Time settings
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#instal-docker" class="md-nav__link">
<span class="md-ellipsis">
Instal Docker
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#create-docker-volume-or-folder" class="md-nav__link">
<span class="md-ellipsis">
Create Docker volume or folder
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#launch-container" class="md-nav__link">
<span class="md-ellipsis">
Launch container
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#update-instal" class="md-nav__link">
<span class="md-ellipsis">
Update instal
</span>
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h1>Docker</h1>
<p>On this page, you can find instructions on how to instal MIND using Docker and how to update a Docker installation.</p>
<h2 id="installation">Installation<a class="headerlink" href="#installation" title="Permanent link">&para;</a></h2>
<h3 id="time-settings">Time settings<a class="headerlink" href="#time-settings" title="Permanent link">&para;</a></h3>
<p>Make sure to set all time related settings (time, date, timezone, etc.) correct on your computer, as MIND depends on it to work correctly.</p>
<h3 id="instal-docker">Instal Docker<a class="headerlink" href="#instal-docker" title="Permanent link">&para;</a></h3>
<p>The first step is to instal Docker, if you don't have it installed already. The official Docker documentation hub offers great instructions on <a href="https://docs.docker.com/engine/install/">how to instal docker CLI and Docker Desktop</a>. Take notice of if you installed the 'Docker CLI' (the Docker documentation also calls this 'Docker CE') or if you installed 'Docker Desktop', for future instructions.</p>
<h3 id="create-docker-volume-or-folder">Create Docker volume or folder<a class="headerlink" href="#create-docker-volume-or-folder" title="Permanent link">&para;</a></h3>
<p>MIND needs a permanent place to put the database file, which contains all the user data and configs. This can be a <a href="https://docs.docker.com/storage/volumes/">Docker volume</a>, or a folder on the host machine.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="1:2"><input checked="checked" id="__tabbed_1_1" name="__tabbed_1" type="radio" /><input id="__tabbed_1_2" name="__tabbed_1" type="radio" /><div class="tabbed-labels"><label for="__tabbed_1_1">Docker Volume</label><label for="__tabbed_1_2">Local Folder</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="tabbed-set tabbed-alternate" data-tabs="2:3"><input checked="checked" id="__tabbed_2_1" name="__tabbed_2" type="radio" /><input id="__tabbed_2_2" name="__tabbed_2" type="radio" /><input id="__tabbed_2_3" name="__tabbed_2" type="radio" /><div class="tabbed-labels"><label for="__tabbed_2_1">Docker CLI</label><label for="__tabbed_2_2">Docker Compose</label><label for="__tabbed_2_3">Docker Desktop</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a>docker<span class="w"> </span>volume<span class="w"> </span>create<span class="w"> </span>mind-db
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a>docker<span class="w"> </span>volume<span class="w"> </span>create<span class="w"> </span>mind-db
</code></pre></div>
</div>
<div class="tabbed-block">
<ul>
<li>Open <code class="highlight">Volumes</code></li>
<li>Click <code class="highlight">Create</code></li>
<li>Enter <code class="highlight">mind-db</code> for the name and click <code class="highlight">Create</code></li>
</ul>
</div>
</div>
</div>
</div>
<div class="tabbed-block">
<div class="tabbed-set tabbed-alternate" data-tabs="3:3"><input checked="checked" id="__tabbed_3_1" name="__tabbed_3" type="radio" /><input id="__tabbed_3_2" name="__tabbed_3" type="radio" /><input id="__tabbed_3_3" name="__tabbed_3" type="radio" /><div class="tabbed-labels"><label for="__tabbed_3_1">Linux</label><label for="__tabbed_3_2">MacOS</label><label for="__tabbed_3_3">Windows</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<p>Linux standards would suggest putting the folder in <code class="highlight">/opt/application_name</code>, as the <code class="highlight">/opt</code> directory is where program options should be stored. This is not mandatory however; you are allowed to create a folder anywhere you like. If we apply the standard to MIND, the folder would be <code class="highlight">/opt/MIND/db</code>.</p>
<p>Create the desired folder using the UI (if your distro offers this) or with the following shell command (replace <code class="highlight">/path/to/directory</code> with desired path):</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a>mkdir<span class="w"> </span><span class="s2">&quot;/path/to/directory&quot;</span>
</code></pre></div>
<div class="admonition info">
<p class="admonition-title">Permissions and ownership</p>
<p>The permissions on this folder need to allow the container to read, write, and execute inside it. It also needs to have proper ownership. More documentation on this subject coming.</p>
</div>
</div>
<div class="tabbed-block">
<p>MacOS standards would suggest putting the folder in <code class="highlight">/Applications/application_name</code>. This is not mandatory however; you are allowed to create a folder anywhere you like. If we apply the standard to MIND, the folder would be <code class="highlight">/Applications/MIND/db</code>.</p>
<p>Create the desired folder using the UI or with the following shell command (replace <code class="highlight">/path/to/directory</code> with desired path):</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a>mkdir<span class="w"> </span><span class="s2">&quot;/path/to/directory&quot;</span>
</code></pre></div>
<div class="admonition info">
<p class="admonition-title">Permissions and ownership</p>
<p>The permissions on this folder need to allow the container to read, write, and execute inside it. It also needs to have proper ownership. More documentation on this subject coming.</p>
</div>
</div>
<div class="tabbed-block">
<p>There is no defined standard for Windows on where to put such a folder. We suggest a path like <code class="highlight">C:\apps\application_name</code>, so that it can be managed easily. This is not mandatory however; you are allowed to create a folder anywhere you like. If we apply this suggestion to MIND, the folder would be <code class="highlight">C:\apps\MIND\db</code>.</p>
<p>Create the desired folder either using the Windows Explorer, or using the following Powershell command:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a><span class="n">mkdir</span> <span class="s2">&quot;C:\apps\MIND\db&quot;</span>
</code></pre></div>
<div class="admonition info">
<p class="admonition-title">Permissions and ownership</p>
<p>The permissions on this folder need to allow the container to read, write, and execute inside it. It also needs to have proper ownership. More documentation on this subject coming.</p>
</div>
</div>
</div>
</div>
</div>
</div>
</div>
<h3 id="launch-container">Launch container<a class="headerlink" href="#launch-container" title="Permanent link">&para;</a></h3>
<p>Now we can launch the container.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="4:3"><input checked="checked" id="__tabbed_4_1" name="__tabbed_4" type="radio" /><input id="__tabbed_4_2" name="__tabbed_4" type="radio" /><input id="__tabbed_4_3" name="__tabbed_4" type="radio" /><div class="tabbed-labels"><label for="__tabbed_4_1">Docker CLI</label><label for="__tabbed_4_2">Docker Compose</label><label for="__tabbed_4_3">Docker Desktop</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<p>The command to get the Docker container running can be found below. But before you copy, paste and run it, read the notes below!</p>
<div class="tabbed-set tabbed-alternate" data-tabs="5:3"><input checked="checked" id="__tabbed_5_1" name="__tabbed_5" type="radio" /><input id="__tabbed_5_2" name="__tabbed_5" type="radio" /><input id="__tabbed_5_3" name="__tabbed_5" type="radio" /><div class="tabbed-labels"><label for="__tabbed_5_1">Linux</label><label for="__tabbed_5_2">MacOS</label><label for="__tabbed_5_3">Windows</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a>docker<span class="w"> </span>run<span class="w"> </span>-d<span class="w"> </span><span class="se">\</span>
<a id="__codelineno-5-2" name="__codelineno-5-2" href="#__codelineno-5-2"></a><span class="w"> </span>--name<span class="w"> </span>mind<span class="w"> </span><span class="se">\</span>
<a id="__codelineno-5-3" name="__codelineno-5-3" href="#__codelineno-5-3"></a><span class="w"> </span>-v<span class="w"> </span><span class="s2">&quot;mind-db:/app/db&quot;</span><span class="w"> </span><span class="se">\</span>
<a id="__codelineno-5-4" name="__codelineno-5-4" href="#__codelineno-5-4"></a><span class="w"> </span>-e<span class="w"> </span><span class="nv">TZ</span><span class="o">=</span>Europe/Amsterdam<span class="w"> </span><span class="se">\</span>
<a id="__codelineno-5-5" name="__codelineno-5-5" href="#__codelineno-5-5"></a><span class="w"> </span>-p<span class="w"> </span><span class="m">8080</span>:8080<span class="w"> </span><span class="se">\</span>
<a id="__codelineno-5-6" name="__codelineno-5-6" href="#__codelineno-5-6"></a><span class="w"> </span>mrcas/mind:latest
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a>docker<span class="w"> </span>run<span class="w"> </span>-d<span class="w"> </span><span class="se">\</span>
<a id="__codelineno-6-2" name="__codelineno-6-2" href="#__codelineno-6-2"></a><span class="w"> </span>--name<span class="w"> </span>mind<span class="w"> </span><span class="se">\</span>
<a id="__codelineno-6-3" name="__codelineno-6-3" href="#__codelineno-6-3"></a><span class="w"> </span>-v<span class="w"> </span><span class="s2">&quot;mind-db:/app/db&quot;</span><span class="w"> </span><span class="se">\</span>
<a id="__codelineno-6-4" name="__codelineno-6-4" href="#__codelineno-6-4"></a><span class="w"> </span>-e<span class="w"> </span><span class="nv">TZ</span><span class="o">=</span>Europe/Amsterdam<span class="w"> </span><span class="se">\</span>
<a id="__codelineno-6-5" name="__codelineno-6-5" href="#__codelineno-6-5"></a><span class="w"> </span>-p<span class="w"> </span><span class="m">8080</span>:8080<span class="w"> </span><span class="se">\</span>
<a id="__codelineno-6-6" name="__codelineno-6-6" href="#__codelineno-6-6"></a><span class="w"> </span>mrcas/mind:latest
</code></pre></div>
</div>
<div class="tabbed-block">
<div class="highlight"><pre><span></span><code><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a><span class="n">docker</span> <span class="n">run</span> <span class="n">-d</span> <span class="p">-</span><span class="n">-name</span> <span class="n">mind</span> <span class="n">-v</span> <span class="s2">&quot;mind-db:/app/db&quot;</span> <span class="n">-e</span> <span class="n">TZ</span><span class="p">=</span><span class="n">Europe</span><span class="p">/</span><span class="n">Amsterdam</span> <span class="n">-p</span> <span class="n">8080</span><span class="p">:</span><span class="n">8080</span> <span class="n">mrcas</span><span class="p">/</span><span class="n">mind</span><span class="p">:</span><span class="n">latest</span>
</code></pre></div>
</div>
</div>
</div>
<p>A few notes about this command:</p>
<ol>
<li>
<p>If you're using a folder on the host machine instead of a docker volume to store the database file (<a href="#create-docker-volume-or-folder">reference</a>), replace <code class="highlight">mind-db</code> with the path to the host folder.<br />
E.g. <code class="highlight">&quot;/opt/MIND/db:/app/db&quot;</code>.<br />
E.g. <code class="highlight">&quot;C:\apps\MIND\db:/app/db&quot;</code>.</p>
</li>
<li>
<p>Replace the timezone value (<code class="highlight">TZ=</code>) with the <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List">TZ database name</a> of your timezone (value of <code class="highlight">TZ identifier</code> on webpage).</p>
</li>
<li>
<p>Information on how to change the port can be found on the <a href="../setup_after_installation/#port">Setup After Installation page</a>.</p>
</li>
</ol>
</div>
<div class="tabbed-block">
<p>The contents of the <code class="highlight">docker-compose.yml</code> file are below. The source file can also be found <a href="https://github.com/Casvt/MIND/blob/Development/docker-compose.yml">on GitHub</a>. But before you copy, paste and run it, read the notes below!</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a>version: &quot;3.3&quot;
<a id="__codelineno-8-2" name="__codelineno-8-2" href="#__codelineno-8-2"></a>services:
<a id="__codelineno-8-3" name="__codelineno-8-3" href="#__codelineno-8-3"></a> mind:
<a id="__codelineno-8-4" name="__codelineno-8-4" href="#__codelineno-8-4"></a> container_name: mind
<a id="__codelineno-8-5" name="__codelineno-8-5" href="#__codelineno-8-5"></a> image: mrcas/mind:latest
<a id="__codelineno-8-6" name="__codelineno-8-6" href="#__codelineno-8-6"></a> volumes:
<a id="__codelineno-8-7" name="__codelineno-8-7" href="#__codelineno-8-7"></a> <span class="k">-</span> &quot;mind-db:/app/db&quot;
<a id="__codelineno-8-8" name="__codelineno-8-8" href="#__codelineno-8-8"></a> environment:
<a id="__codelineno-8-9" name="__codelineno-8-9" href="#__codelineno-8-9"></a> <span class="k">-</span> TZ=Europe/Amsterdam
<a id="__codelineno-8-10" name="__codelineno-8-10" href="#__codelineno-8-10"></a> ports:
<a id="__codelineno-8-11" name="__codelineno-8-11" href="#__codelineno-8-11"></a> <span class="k">-</span> 8080:8080
<a id="__codelineno-8-12" name="__codelineno-8-12" href="#__codelineno-8-12"></a>
<a id="__codelineno-8-13" name="__codelineno-8-13" href="#__codelineno-8-13"></a>volumes:
<a id="__codelineno-8-14" name="__codelineno-8-14" href="#__codelineno-8-14"></a> mind-db:
</code></pre></div>
<p>Then run the following command to start the container. Run this command from within the directory where the <code class="highlight">docker-compose.yml</code> file is located.</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-9-1" name="__codelineno-9-1" href="#__codelineno-9-1"></a>docker-compose<span class="w"> </span>up<span class="w"> </span>-d
</code></pre></div>
<p>A few notes about the <code class="highlight">docker-compose.yml</code> file:</p>
<ol>
<li>
<p>If you're using a folder on the host machine instead of a docker volume to store the database file (<a href="#create-docker-volume-or-folder">reference</a>), replace <code class="highlight">mind-db</code> with the path to the host folder.<br />
E.g. <code class="highlight">&quot;/opt/MIND/db:/app/db&quot;</code>.<br />
E.g. <code class="highlight">&quot;C:\apps\MIND\db:/app/db&quot;</code>.</p>
</li>
<li>
<p>Replace the timezone value (<code class="highlight">TZ=</code>) with the <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List">TZ database name</a> of your timezone (value of <code class="highlight">TZ identifier</code> on webpage).</p>
</li>
<li>
<p>Information on how to change the port can be found on the <a href="../setup_after_installation/#port">Setup After Installation page</a>.</p>
</li>
</ol>
</div>
<div class="tabbed-block">
<ol>
<li>Click the search bar at the top and search for <code class="highlight">mrcas/mind</code>.</li>
<li>Click <code class="highlight">Run</code> on the entry saying <code class="highlight">mrcas/mind</code>.</li>
<li>Open <code class="highlight">Images</code>, and on the right, under <code class="highlight">Actions</code> click the play/run button for <code class="highlight">mrcas/mind</code>.</li>
<li>Expand the 'Optional settings'.</li>
<li>For the <code class="highlight">Container name</code>, set the value to <code class="highlight">mind</code>.</li>
<li>For the <code class="highlight">Host port</code>, set the value to <code class="highlight"><span class="mf">8080</span></code>. Information on how to change the port can be found on the <a href="../setup_after_installation/#port">Setup After Installation page</a>.</li>
<li>For the <code class="highlight">Host path</code>, set the value to <code class="highlight">mind-db</code> if you are using a Docker volume for the database. Otherwise, set it to the folder where you want to store the database, <a href="#create-docker-volume-or-folder">that you created earlier</a>. Set the accompanying <code class="highlight">Container path</code> to <code class="highlight">/app/db</code>.</li>
<li>For the <code class="highlight">Variable</code>, set the value to <code class="highlight">TZ</code>. Set the accompanying <code class="highlight">Value</code> to the <a href="https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List">TZ database name</a> of your timezone (value of <code class="highlight">TZ identifier</code> on webpage). E.g. <code class="highlight">Europe/Amsterdam</code>.</li>
</ol>
</div>
</div>
</div>
<h2 id="update-instal">Update instal<a class="headerlink" href="#update-instal" title="Permanent link">&para;</a></h2>
<p>Below you can find instructions on how to update an instal.</p>
<div class="tabbed-set tabbed-alternate" data-tabs="6:3"><input checked="checked" id="__tabbed_6_1" name="__tabbed_6" type="radio" /><input id="__tabbed_6_2" name="__tabbed_6" type="radio" /><input id="__tabbed_6_3" name="__tabbed_6" type="radio" /><div class="tabbed-labels"><label for="__tabbed_6_1">Docker CLI</label><label for="__tabbed_6_2">Docker Compose</label><label for="__tabbed_6_3">Docker Desktop</label></div>
<div class="tabbed-content">
<div class="tabbed-block">
<p>If needed, run these commands with <code class="highlight">sudo</code>. It is assumed that the name of the container is <code class="highlight">mind</code> (which is set using the <code class="highlight">--name</code> option in the command).</p>
<ol>
<li><code class="highlight">docker container stop mind</code></li>
<li><code class="highlight">docker container rm mind</code></li>
<li><code class="highlight">docker image rm mrcas/mind:latest</code></li>
<li>Run the command you previously used to start the container.</li>
</ol>
</div>
<div class="tabbed-block">
<p>If needed, run these commands with <code class="highlight">sudo</code>. You need to be in the same directory as the <code class="highlight">docker-compose.yml</code> file when running these commands.</p>
<ol>
<li><code class="highlight">docker-compose down</code></li>
<li><code class="highlight">docker-compose pull</code></li>
<li><code class="highlight">docker-compose up -d</code></li>
<li><code class="highlight">docker image prune -f</code></li>
</ol>
</div>
<div class="tabbed-block">
<ol>
<li>Open <code class="highlight">Containers</code> and locate the <code class="highlight">mind</code> container in the list.</li>
<li>Click the stop button on the right, then the delete button.</li>
<li>Open <code class="highlight">Images</code> and locate the <code class="highlight">mrcas/mind</code> image in the list.</li>
<li>Click the delete button on the right.</li>
<li>Repeat the steps of <a href="#launch-container">launching the container</a>.</li>
</ol>
</div>
</div>
</div>
<aside class="md-source-file">
<span class="md-source-file__fact">
<span class="md-icon" title="Last update">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M21 13.1c-.1 0-.3.1-.4.2l-1 1 2.1 2.1 1-1c.2-.2.2-.6 0-.8l-1.3-1.3c-.1-.1-.2-.2-.4-.2m-1.9 1.8-6.1 6V23h2.1l6.1-6.1zM12.5 7v5.2l4 2.4-1 1L11 13V7zM11 21.9c-5.1-.5-9-4.8-9-9.9C2 6.5 6.5 2 12 2c5.3 0 9.6 4.1 10 9.3-.3-.1-.6-.2-1-.2s-.7.1-1 .2C19.6 7.2 16.2 4 12 4c-4.4 0-8 3.6-8 8 0 4.1 3.1 7.5 7.1 7.9l-.1.2z"/></svg>
</span>
<span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-timeago" title="September 3, 2025 14:14:56 UTC"><span class="timeago" datetime="2025-09-03T14:14:56+00:00" locale="en"></span></span><span class="git-revision-date-localized-plugin git-revision-date-localized-plugin-iso_date" title="September 3, 2025 14:14:56 UTC">2025-09-03</span>
</span>
</aside>
</article>
</div>
<script>var tabs=__md_get("__tabs");if(Array.isArray(tabs))e:for(var set of document.querySelectorAll(".tabbed-set")){var labels=set.querySelector(".tabbed-labels");for(var tab of tabs)for(var label of labels.getElementsByTagName("label"))if(label.innerText.trim()===tab){var input=document.getElementById(label.htmlFor);input.checked=!0;continue e}}</script>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
Back to top
</button>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "../..", "features": ["content.tabs.link", "content.code.copy", "header.autohide", "navigation.expand", "navigation.indexes", "navigation.instant", "navigation.sections", "navigation.tabs", "navigation.tabs.sticky", "navigation.top", "navigation.tracking"], "search": "../../assets/javascripts/workers/search.973d3a69.min.js", "tags": null, "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}, "version": null}</script>
<script src="../../assets/javascripts/bundle.92b07e13.min.js"></script>
<script src="../../js/timeago.min.js"></script>
<script src="../../js/timeago_mkdocs_material.js"></script>
</body>
</html>
Reference in New Issue View Git Blame Copy Permalink