summaryrefslogtreecommitdiff
path: root/pages/docs/client/user-running.md
blob: 2fda469f136e190a10ba2888ece09a1a8344cd5d (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
@nav_title = 'Running'
@title = 'Running Bitmask'

This document covers how to launch Bitmask. Also know as, where the
magic happens.

Launching Bitmask
-----------------

After a successful installation, there should be a launcher called
bitmask somewhere in your path:

    % bitmask

The first time you launch it, it should launch the first run wizard that
will guide you through the mostly automatic configuration of the LEAP
Services.

> **note**
>
> You will need to enter a valid test provider running the LEAP
> Platform. You can use the LEAP test service, *<https://bitmask.net>*

Debug mode
----------

If you are happy having lots of output in your terminal, you will like
to know that you can run bitmask in debug mode:

    $ bitmask --debug

If you ask for it, you can also have all that debug info in a beautiful
file ready to be attached to your bug reports:

    $ bitmask --debug --logfile /tmp/leap.log

I want all the options!
-----------------------

To see all the available command line options:

    $ bitmask --help