blob: d2edb05ee8a9f696d1a43bc2e4ddd3a900702bc9 [file] [log] [blame]
Yingdi Yucf63b072013-11-11 02:03:46 -08001ChronoChat Manual
2===================================================================
3
Yingdi Yu2d1e9fb2013-11-11 11:55:55 -08004**Step 0**: Before open ChronoChat, make sure ndnd is running on your machine.
Yingdi Yu9740cc82013-11-11 11:25:05 -08005If you have installed `NDNx Control Center`_, check if its tray icon shows up
6
7.. _NDNx Control Center: http://named-data.net/download/
8
Yingdi Yu9a7f0452013-11-11 11:34:45 -08009.. image:: https://raw.github.com/bruinfish/ChronoChat-V2/master/doc/img/ncc.png
10
Yingdi Yud240f9e2013-11-11 11:46:39 -080011You also need to have your default key generated and certificate installed.
Yingdi Yu2d1e9fb2013-11-11 11:55:55 -080012To check that, you can use a command line tool **ndnsec-ls-identity**, and you should see output similar to:
Yingdi Yud240f9e2013-11-11 11:46:39 -080013
14.. image:: https://raw.github.com/bruinfish/ChronoChat-V2/master/doc/img/ndnsec-ls-identity.png
15
16If you see nothing or something different in output, please go to `NDN Certifications`_ to set up your security environment.
17
18.. _NDN Certifications: http://ndncert.named-data.net/
Yingdi Yu9740cc82013-11-11 11:25:05 -080019
Yingdi Yu2d1e9fb2013-11-11 11:55:55 -080020**Step 1**: When you open ChronoChat App, you should see a contact panel as shown below.
Yingdi Yu83bd29d2013-11-11 02:12:17 -080021
Yingdi Yu4e50fb62013-11-11 02:06:56 -080022.. image:: https://raw.github.com/bruinfish/ChronoChat-V2/master/doc/img/chronochat-1.png
Yingdi Yu83bd29d2013-11-11 02:12:17 -080023
Yingdi Yuccd50ee2013-11-11 12:04:37 -080024You should see **Setting** button at the bottom of the panel.
Yingdi Yuf4784a42013-11-11 12:08:09 -080025You can change your identity and setting there.
Yingdi Yuccd50ee2013-11-11 12:04:37 -080026
27.. image:: https://raw.github.com/bruinfish/ChronoChat-V2/master/doc/img/setting-dialog.png
28
Yingdi Yuf4784a42013-11-11 12:08:09 -080029The default setting is derived from the key and certificate you installed in step 0.
30
Yingdi Yu2d1e9fb2013-11-11 11:55:55 -080031The left part of the panel is your contact list.
32One must be one of your contacts if she/he wants to have a chat with you.
33Right now, it is empty, so let's add some contacts.
34
Yingdi Yued627862013-11-11 12:30:15 -080035.. image:: https://raw.github.com/bruinfish/ChronoChat-V2/master/doc/img/chronochat-2.png
Yingdi Yu2d1e9fb2013-11-11 11:55:55 -080036
Yingdi Yued627862013-11-11 12:30:15 -080037**Step 2**: Click the **Add** button in the lower left corner.
38You should see a "Browse Contact" dialog which collects all the existing contact certificate in the testbed, for example:
39
40.. image:: https://raw.github.com/bruinfish/ChronoChat-V2/master/doc/img/browse-contact-1.png
Yingdi Yua19935a2013-11-11 12:00:06 -080041
42You can select the contact you want to add, and then click the **Add** button.
43Then you should see that the selected contact has been added into your contact list.
44
Yingdi Yu8ef48412013-11-11 12:11:07 -080045.. image:: https://raw.github.com/bruinfish/ChronoChat-V2/master/doc/img/chronochat-3.png
Yingdi Yua19935a2013-11-11 12:00:06 -080046
Yingdi Yued627862013-11-11 12:30:15 -080047If you know a contact's certificate name, you can add it directly via **Direct Add** button.
48
49.. image:: https://raw.github.com/bruinfish/ChronoChat-V2/master/doc/img/browse-contact-2.png
50
51You should see an "Add Contact" dialog, you can directly input the contact certificate name (without version number, e.g., /ndn/edu/ucla/KEY/cs/afanasev/ksk-1383327806/ID-CERT) into the **Contact** line, and then click **Fetch** button.
52
53.. image:: https://raw.github.com/bruinfish/ChronoChat-V2/master/doc/img/add-contact-1.png
54
55If the certificate can be fetched and verified, the dialog will show you the description about the certificate subject.
56
57.. image:: https://raw.github.com/bruinfish/ChronoChat-V2/master/doc/img/add-contact-2.png
Yingdi Yua19935a2013-11-11 12:00:06 -080058