summaryrefslogtreecommitdiff
path: root/README.md
diff options
context:
space:
mode:
authorThomas Hirsch <t.hirsch@liquidlabs.de>2016-02-16 16:50:24 +0100
committerThomas Hirsch <t.hirsch@liquidlabs.de>2016-02-26 15:09:12 +0100
commitffe802239a73f3d042216a61f718539db97d001b (patch)
treee78a722889da6916b5a4a4c0a769966bb844856d /README.md
parentdbb434b56e6b161a3b851ae6a81f96dff14a29da (diff)
added note about credentials config file
Diffstat (limited to 'README.md')
-rw-r--r--README.md12
1 files changed, 12 insertions, 0 deletions
diff --git a/README.md b/README.md
index 20fdc535..a8f5a22a 100644
--- a/README.md
+++ b/README.md
@@ -52,6 +52,18 @@ Type your password:
6) Connect to the provider using your credentials, as shown in step 5 above. If the user agent starts up successfully, you will not see any other output.
+**Note** For more convenience during development, you can also create a config file with your credentials (ini format). Example:
+
+*credentials.ini*
+```
+[pixelated]
+leap_server_name=dev.pixelated-project.org
+leap_username=<your_username>
+leap_password=<your_password>
+```
+Then start the user agent like this:
+`$ pixelated-user-agent --host 0.0.0.0 --config credentials.ini`
+
7) Go to [localhost:3333](http://localhost:3333/). You should see a loading screen for a few seconds, then your inbox. If it sticks on the loading screen, check your terminal for errors, then [get help](https://pixelated-project.org/faq/#contact-the-project).
8) If you like console output, you can also run the tests to see if everything went according to plan.