diff --git a/faq/README.md b/faq/README.md index 7e2a441..976f9f9 100644 --- a/faq/README.md +++ b/faq/README.md @@ -1,27 +1,95 @@ + + # Frequently Asked Questions The following page hosts most frequently asked questions as seen on our [issues](https://github.com/MISP/issues) and [gitter](https://gitter.im/MISP/MISP). -## permission issues +## Permission issues If you have any permission issues, please [set the permissions](https://misp.github.io/MISP/INSTALL.ubuntu1804/#5-set-the-permissions) to something sane first. +## When to update MISP? + +One question might be how often to update MISP. +You can update MISP as ofte as you like. If you see the follwing: + +![MISP Update](./figures/misp-diag-update.png) + +This means that the main repository has an update available. + +If you want to play it safer or want to integrate it in your Weekly/Bi-Monthly update routine you can track our [Changelog](https://www.misp-project.org/Changelog.txt) a more up to date version is available [here](https://misp.github.io/MISP/Changelog/) + ## Update MISP fails +If your MISP instance is outdated, meaning ONLY the core, not the modules or dashboard or python modules, you well see the following. + ![MISP outdated](./figures/misp-outdated.png) +Once you click on update MISP you will be asked confirmation. + ![MISP Update Yes/No](./figures/update-misp-YN.png) -If you are not on a branch, the update will fail. +If you are not on a branch, the UI will tell you this, the update will fail. ![not on branch](./figures/misp-not-on-branch.png) +If you cannot write the **.git** files and directory as the user running the web server (and thus PHP), the update will fail. +The following diagnostic check will let you know if you can update or not. + +![.git not writeable](./figures/misp-diag-not-writeable-files-git.png) + +In case you get a file not found on **.git/ORIG_HEAD**, this means that you have never updated your MISP OR you have installed git from an archive file (like .zip/.tar.gz or similar) +Try to click update MISP and see what happens. + +![ORIG_HEAD file not found](./figures/misp-diag-writeable-files-not_found-git.png) + +### What can go wrong if I update MISP? + +In theory nothing. We put great effort into protecting the integrity of the data stored in your MISP instance. +DB upgrades happen upon login or on reload once you have update the repository. +You cannot "break" anything by clicking **Update MISP** worse case it will complain about something and you will certainly find the answer on this page. + +IF not, please open an [issue](https://github.com/MISP/MISP/issues) on GitHub or come to our [gitter](https://gitter.im/MISP/MISP) chat to see if the community can help. + ### error: pathspec 'app/composer.json' did not match any file(s) known to git -This is not an error and can be ignore. Nothing will be impacted by this. +This is **not** an error and can be ignore. Nothing will be impacted by this. ![pathspec](./figures/misp-pathspec.png) +### MISP modules "Connection refused" + +![MISP Modules ](./figures/misp-module-system-diag.png) + +If you get have a **Connection refused state** on your modules one of the following might be true. + +- You have no [misp-modules](https://github.com/MISP/misp-modules) not installed +- They are instaled but not running +- Something completly different + +If they are not installed, check out this section of the [INSTALL guide](https://github.com/MISP/misp-modules/#how-to-install-and-start-misp-modules-in-a-python-virtualenv) of [misp-modules](https://github.com/MISP/misp-modules). + +In case they are not running, try this on the console: + +``` +sudo -u www-data /var/www/MISP/venv/bin/misp-modules -l 127.0.0.1 -s & +``` + +OR if you were foolish enough to not install in a Python virtualenv: + +``` +sudo -u www-data misp-modules -l 127.0.0.1 -s & +``` + +:warning: Running misp-modules like this will certainly kill it once you quit the session. Make sure it is in your **/etc/rc.local** or some ther init script that gets run on boot. + +## Uninstalling MISP + +There is no official procedure to uninstalling a MISP instance. + +If you want to re-use a machine where MISP was installed, wipe the machine and do a fresh install. +Consider the data in your MISP instance as potentially confidential and if you synchronized with other instances, be respectful and wipe it clean. + diff --git a/faq/figures/misp-diag-not-writeable-files-git.png b/faq/figures/misp-diag-not-writeable-files-git.png new file mode 100644 index 0000000..2cb1fdf Binary files /dev/null and b/faq/figures/misp-diag-not-writeable-files-git.png differ diff --git a/faq/figures/misp-diag-update.png b/faq/figures/misp-diag-update.png new file mode 100644 index 0000000..499c4da Binary files /dev/null and b/faq/figures/misp-diag-update.png differ diff --git a/faq/figures/misp-diag-writeable-files-not_found-git.png b/faq/figures/misp-diag-writeable-files-not_found-git.png new file mode 100644 index 0000000..c1485e4 Binary files /dev/null and b/faq/figures/misp-diag-writeable-files-not_found-git.png differ