summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorFelix Hammerl <felix.hammerl@gmail.com>2016-02-26 18:44:35 +0100
committerFelix Hammerl <felix.hammerl@gmail.com>2016-02-26 18:44:35 +0100
commit2fdf556d75e8d2b24d04511fcd9284a27ea3142a (patch)
tree7ce6f591296aebec4118bb501ff76c1d6b6e2482
parentdbb434b56e6b161a3b851ae6a81f96dff14a29da (diff)
parent460605c022d151aaad2434b4f6c634fd135f2acb (diff)
Merge pull request #633 from thokari/pixelated-master
README additions continued from https://github.com/pixelated/pixelated-user-agent/pull/610
-rw-r--r--.gitignore1
-rw-r--r--README.md19
2 files changed, 20 insertions, 0 deletions
diff --git a/.gitignore b/.gitignore
index e585b65e..5197d853 100644
--- a/.gitignore
+++ b/.gitignore
@@ -30,6 +30,7 @@ __pycache__/
.virtualenv
# custom config file that can be used with the useragent
/config
+credentials.ini
pixelated.cfg
service/_trial_temp/
web-ui/coverage
diff --git a/README.md b/README.md
index 20fdc535..4cac3007 100644
--- a/README.md
+++ b/README.md
@@ -52,6 +52,8 @@ 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 (see **Further Notes**).
+
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.
@@ -124,6 +126,23 @@ To run the pixelated user agent multi user mode, please run the following:
You will need to change `dev.pixelated-project.org` to the hostname of the leap provider that you will be using.
Once that is done, you can use by browsing to [http://localhost:3333](http://localhost:3333), where you will be prompted for your email username and password.
+## Config file with credentials
+
+The config file has to be in `ini` format, see for example
+`try.alice.ini` or `try.bob.ini` in the root directory, or this one:
+
+*credentials.ini*
+```
+[pixelated]
+leap_server_name=dev.pixelated-project.org
+leap_username=<your_username>
+leap_password=<your_password>
+```
+To use it start the user agent like this:
+`$ pixelated-user-agent --host 0.0.0.0 --config credentials.ini`
+
+You can also include the host in the config file, as shown in the example files given above.
+
## Self-signed provider certs
You might also need to add your LEAP provider ssl certificate to pixelated manually for now, with the following steps: