From ffe802239a73f3d042216a61f718539db97d001b Mon Sep 17 00:00:00 2001 From: Thomas Hirsch Date: Tue, 16 Feb 2016 16:50:24 +0100 Subject: added note about credentials config file --- .gitignore | 1 + README.md | 12 ++++++++++++ 2 files changed, 13 insertions(+) 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..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= +leap_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. -- cgit v1.2.3 From 4f621e67a4ff95913d7c760c298c5c37870e76bf Mon Sep 17 00:00:00 2001 From: Thomas Hirsch Date: Wed, 17 Feb 2016 16:03:26 +0100 Subject: moved config file hint down to further notes --- README.md | 26 +++++++++++++++----------- 1 file changed, 15 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index a8f5a22a..09616ac3 100644 --- a/README.md +++ b/README.md @@ -52,17 +52,7 @@ 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= -leap_password= -``` -Then start the user agent like this: -`$ pixelated-user-agent --host 0.0.0.0 --config credentials.ini` +**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). @@ -136,6 +126,20 @@ 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, example: + +*credentials.ini* +``` +[pixelated] +leap_server_name=dev.pixelated-project.org +leap_username= +leap_password= +``` +To use it start the user agent like this: +`$ pixelated-user-agent --host 0.0.0.0 --config credentials.ini` + ## Self-signed provider certs You might also need to add your LEAP provider ssl certificate to pixelated manually for now, with the following steps: -- cgit v1.2.3 From 460605c022d151aaad2434b4f6c634fd135f2acb Mon Sep 17 00:00:00 2001 From: Thomas Hirsch Date: Thu, 18 Feb 2016 15:15:58 +0100 Subject: included hints to example config files --- README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 09616ac3..4cac3007 100644 --- a/README.md +++ b/README.md @@ -128,7 +128,8 @@ Once that is done, you can use by browsing to [http://localhost:3333](http://loc ## Config file with credentials -The config file has to be in `ini` format, example: +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* ``` @@ -140,6 +141,8 @@ leap_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: -- cgit v1.2.3 From e4e98d3ee336b18c2a00e3f518a239894b7fcf4e Mon Sep 17 00:00:00 2001 From: thaissiqueira Date: Fri, 26 Feb 2016 17:55:16 -0300 Subject: Change image source while Github (Camo) is broken --- README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/README.md b/README.md index 4cac3007..f404f591 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,7 @@ Here's a [podcast](https://soundcloud.com/thoughtworks/pixelated-why-secure-comm **Pixelated is still in early development state!** -![High level architecture User Agent](https://pixelated-project.org/assets/images/pixelated-user-agent.png) +![High level architecture User Agent](https://raw.githubusercontent.com/pixelated/website/master/assets/images/pixelated-user-agent.png) ## Getting started -- cgit v1.2.3