Merge branch 'dev'

README.md

@@ -117,15 +117,15 @@ gpgcheck = 1
 ```
 
 ### Install prerequisities
-Enable IUS, EPEL, and IUS repositories
+Enable IUS, EPEL, and SCL repositories
 ```
 yum install -y https://$(rpm -E '%{?centos:centos}%{!?centos:rhel}%{rhel}').iuscommunity.org/ius-release.rpm
 yum install -y epel-release centos-release-scl
 ```
 
 Install necessary packages:
 ```
-yum install -y devtoolset-7 m4 libtool autoconf automake  git vim httpd php php-mysql mod_wsgi mariadb-server mariadb-devel zlib libcurl-devel openssl-libs python python36 python36u-mod_wsgi python36u-setuptools  MySQL-python python2-PyMySQL  boost* pkgconfig libnotify
+yum install -y devtoolset-7 m4 libtool autoconf automake  git vim httpd php php-mysql mod_wsgi mariadb-server mariadb-devel zlib libcurl-devel openssl-libs openssl-devel python python36 python36u-mod_wsgi python36u-setuptools  MySQL-python python2-PyMySQL  boost* pkgconfig libnotify
 ```
 Set Python 3.6 as default Python3 version:
 ```
@@ -146,7 +146,7 @@ systemctl enable mariadb.service
 useradd -m -c "BOINC Administrator" boincadm  -s /bin/bash
 mysql -u root -p
 mysql> create database fitcrack;
-mysql> GRANT ALL PRIVILES ON fitcrack.* TO 'fitcrack'@'localhost' IDENTIFIED BY 'mypassword';
+mysql> GRANT ALL PRIVILEGES ON fitcrack.* TO 'fitcrack'@'localhost' IDENTIFIED BY 'mypassword';
 ```
 
 ### Switch to GCC6 and Install Fitcrack

docs/README.md

@@ -1,11 +1,9 @@
-# Fitcrack Webadmin user manual
+# Fitcrack Webadmin User's Guide
 
-Blah blah blah this is **a user manual**. It shows you how to do things.
+Welcome to the Fitcrack User's Guide. A comprehensive documentation of the Webadmin app used to control the password cracking system developed at BUT FIT.
 
 ![App preview](./_media/img/frontpage.png)
 
-!> Look at the screenshot! It's important.
-
 ## Fitcrack — Distributed password cracking system
 
 **Fitcrack** is a distributed password cracking system. It can be used for recovering passwords securing various types of encrypted media like documents, archives, or disk volumes, as well as for breaking raw cryptographic hashes.
@@ -14,4 +12,4 @@ Thanks to the integration with [Hashcat](https://hashcat.net/) tool, Fitcrack pr
 
 Our system is based on [BOINC](http://boinc.berkeley.edu/) framework for distributed computing which allows Fitcrack to provide a relatively high level of automatization whithout limiting the flexibility of the system, or administrator’s freedom of creating a custom design and configuration of a distributed network.
 
-Fitcrack was created within the [NES@FIT](http://www.fit.vutbr.cz/research/groups/nes@fit/index.php.en) reasearch group on [Faculty of Information Technology, Brno University of Technology](http://www.fit.vutbr.cz/.en). Rather than a ready-made product, it represents an experimental prototype primarily used for research and testing of new password recovery techniques. It is freely available under [MIT license](https://opensource.org/licenses/MIT) Since Fitcrack is an experimental prototype, you can only use it at your own risk. We will not be held in any way responsible for your decision. For using Wrathion we provide no support, or assistance.
+Fitcrack was created within the [NES@FIT](http://www.fit.vutbr.cz/research/groups/nes@fit/index.php.en) reasearch group on [Faculty of Information Technology, Brno University of Technology](http://www.fit.vutbr.cz/.en). Rather than a ready-made product, it represents an experimental prototype primarily used for research and testing of new password recovery techniques. It is freely available under [MIT license](https://opensource.org/licenses/MIT) Since Fitcrack is an experimental prototype, you can only use it at your own risk. We will not be held in any way responsible for your decision.

docs/_sidebar.md

@@ -1,25 +1,25 @@
-- Getting started
-  - [Quick start](guide/start.md)
-  - [Navigating the app](guide/app.md)
-  - [Basic principles](guide/principles.md)
-  - [Jobs](guide/jobs.md)
-  - [Host nodes](guide/hosts.md)
+- Getting Started
+  - [Quick Start](guide/start.md)
+  - [Navigating the App](guide/app.md)
+  <!-- - [Basic Principles](guide/principles.md) -->
+  <!-- - [Jobs](guide/jobs.md) -->
+  - [Host Nodes](guide/hosts.md)
 
-- Creating jobs
+- Creating Jobs
   - [Overview](jobs/creating/overview.md)
   - [Input](jobs/creating/input.md)
-  - [Attack modes](jobs/creating/attacks.md)
+  - [Attack Modes](jobs/creating/attacks.md)
 
-- Managing jobs
-  - [Jobs list](jobs/managing/list.md)
-  - [Detail view](jobs/managing/detail.md)
-  - [Controlling jobs](jobs/managing/actions.md)
+- Managing Jobs
+  - [Jobs List](jobs/managing/list.md)
+  - [Detail View](jobs/managing/detail.md)
+  - [Controlling Jobs](jobs/managing/actions.md)
 
-- Asset library
-  - [Hash cache](assets/hashes.md)
-  - [Attack utilities](assets/utilities.md)
+- System Library
+  - [Hash Cache](library/hashes.md)
+  - [Cracking Assets](library/assets.md)
 
-- System
-  - [Users and roles](system/users.md)
-  - [Host management](system/hosts.md)
-  - [Server monitoring](system/server.md)
+- System Management
+  <!-- - [Users and Roles](system/users.md) -->
+  - [Host Management](system/hosts.md)
+  - [Server Monitoring](system/server.md)

docs/guide/app.md

@@ -1 +1,39 @@
-> TODO
+Navigating the App
+==================
+
+Webadmin is a web application and you can use it on any device with a web browser that has access to your server. This means that the app will look different on various form factors, for example a phone.
+
+After logging in, you will see a permanent app bar up at the top and a navigation menu on the left. These are always available regardless of current context.
+
+> Note that the navigation may be hidden on narrower screens. To toggle it, use the hamburger menu icon on the far left of the app bar or swipe from the left edge on a touch screen.
+
+
+App Bar and Notifications
+-------------------------
+
+The app bar is always at the top and gives you access to the navigation, if it is hidden. On the right side, there is a button to open the notification drawer and a sign out button.
+
+![App Bar Actions](../_media/img/appbar.jpg)
+
+The notification drawer shows all of the notifications you received about job statuses and more. They are shown from newest to oldest.
+
+![Notification Drawer](../_media/img/notifications.jpg)
+
+
+Main Navigation
+---------------
+
+The main navigation links to every part of the system. You can find a very brief overview of each of them below.
+
+![Navigation Bar](../_media/img/navbar.jpg)
+
+- __Dashboard__ – The default view with an excerpt from critical parts of the system
+- __Add Job__ – The job creation form, see [Creating Jobs](/jobs/creating/overview.md)
+- __All Jobs__ – Lists all created jobs, see [Jobs List](/jobs/managing/list.md)
+- __Hosts__ – Lists all host nodes connected to the system
+- __Hashes__ – Shows hashes known and stored by the system
+- __Dictionaries, PCFG, Rules, Charsets, Masks and Markov Chains__ – Shows the respective assets used in cracking and allows creating or uploading them
+- __Manage Users__ – Allows administrators to create and change user accounts, and to create or assign roles
+- __My Account__ – Shows the logged in user's info and allows them to change their password
+- __Settings__ – Shows various settings for Webadmin and also for the Fitcrack configuration
+- __Server Monitor__ – Shows server resource usage and service status

docs/guide/hosts.md

@@ -1 +1,46 @@
-> TODO
+Host Nodes
+==========
+
+Since Fitcrack is a distributed system, the server running Webadmin and the database is not itself doing the cracking (unless you want it to). The jobs are distributed between compute nodes (hosts) that you connect to the system using [BOINC](//boinc.berkeley.edu).
+
+Hosts can only be added by attaching their BOINC client to the Fitcrack project on your server. They can also only be removed by detaching the project. In other words, you have no control over them in Webadmin.
+
+When Fitcrack distributes workunits (parts of jobs), it takes into account the capabilities of each host. The workunits are tailor-made for that hardware's power.
+
+
+Connecting Hosts
+----------------
+
+To connect a machine to the system, it needs to run Windows or Linux. The BOINC client software is also required, as that is what Fitcrack uses to communicate with hosts. Install it from the official website or using a package manager on your system.
+
+### Using BOINC Manager
+
+In a desktop environment, you can use the BOINC GUI. The screenshots below are actually platform-agnostic.
+
+1. Click _Add Project_ in BOINC (or, if in the advanced view, select _Tools > Add Project_ from the menu bar)
+
+2. Enter the URL of the server where your Fitcrack installation is running, with `/fitcrack` at the end 
+
+![Adding a project in BOINC](../_media/img/boinc-url.png)
+
+3. Create a new user (or use existing project credentials in later connections)
+
+![Registering a user in BOINC](../_media/img/boinc-user.png)
+
+4. Finish adding the project, your host will soon appear in Webadmin
+
+> Note that BOINC Manager will open a webpage of the project to finish your registration. You should fill out your name and confirm, but you __do not have to search for or join a team!__
+
+### Using the command line
+
+If you want to connect a host without a graphical display, for example a server you tunnel into via ssh, you can use the `boinccmd` utility.
+
+1. __Get a key__ by creating or looking up an account
+    - To create an account, run `boinccmd --create_account <URL> <email> <password> <name>`
+      (Mirroring the Manager example: `boinccmd --create_account http://mycracker.example.org/fitcrack lemon@mib.jp fufufufu Lemon`)
+    - If you have an existing account, run `boinccmd --lookup_account <URL> <email> <password>` 
+      (With example credentials, this becomes `boinccmd --lookup_account http://mycracker.example.org/fitcrack lemon@mib.jp fufufufu`)
+2. Copy the account key returned by the `create_account` or `lookup_account` command
+3. Run `boinccmd --project_attach <URL> <account_key>` __with the key you copied__
+   (Again, for the Manager example: `boinccmd --project_attach http://mycracker.example.org/fitcrack 3bc280b...`)
+4. That's all, your host will soon appear in Webadmin

docs/guide/jobs.md

@@ -1 +1,6 @@
-> TODO
+Jobs
+====
+
+Cracking jobs are the tasks that Fitcrack distributes among your connected hosts. They contain hashes you want to try to crack, define a cracking method and which hosts their workunits will be distributed to.
+
+This page is useless.

docs/guide/principles.md

@@ -1 +1,4 @@
-> TODO
+Password Cracking Basics
+========================
+
+> Sorry, this section is still a work in progress.

docs/guide/start.md

@@ -1,3 +1,35 @@
-# Test
+Getting Started with Fitcrack
+=============================
 
-Hi!
+Welcome to Fitcrack – The distributed password cracking system. This is your comprehensive and friendly user's guide. It focuses on the Webadmin app, which is the primary way of controlling the Fitcrack system. It was designed to be elegant and as user-friendly as possible for a password cracking control panel. Here's what you can expect to find in this documentaion:
+
+- Getting familliar with the interface
+- An overview of how Fitcrack works
+- How to connect compute nodes
+- How to create a cracking job
+- What options are available for cracking
+- How to work with jobs
+- How to extend the system asset library
+- How to manage users and resources
+
+Before we can get started with all of that, however, you will want to have Fitcrack installed and ready to go. If you don't know what to do, please refer to the [installation guide](//github.com/nesfit/fitcrack/blob/master/README.md). After setting up, come back and we can get started.
+
+
+Preflight Checks
+----------------
+
+After installing Fitcrack, you should have the system ready to use on your server. It is the main control center, housing the central database, communicating with all of the connected host nodes, and, crucially for us, running the Webadmin suite.
+
+Now, depending on how you set the system up and whether you are exposing the web server to the internet, there will be different ways of connecting to Webadmin. In any case, you should be able to launch the app by visiting your server's domain via a web browser. When you do, you should be greeted by a login screen, just like below.
+
+![Fitcrack Login](../_media/img/login.jpg)
+
+
+First login
+-----------
+
+After a fresh install of Fitcrack, there is a default administrator user for Webadmin ready to go. To log in, use the following credentials: Username `fitcrack` with password `FITCRACK`.
+
+It is a good idea to change the password after your first login. To do this, visit the _My Account_ page from the main navigatoin bar on the left and use the _Change Password_ box.
+
+And that's it, you have successfully logged into Webadmin and are now ready to start using Fitcrack! Let's go take a look around the app next.

docs/index.html

@@ -2,7 +2,7 @@
 <html lang="en">
 <head>
   <meta charset="UTF-8">
-  <title>Fitcrack Docs</title>
+  <title>Fitcrack User's Guide</title>
   <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1" />
   <meta name="description" content="Documentation for the distributed password cracking system Fitcrack">
   <meta name="viewport" content="width=device-width, user-scalable=no, initial-scale=1.0, maximum-scale=1.0, minimum-scale=1.0">