-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathindex.html
1267 lines (1188 loc) · 78.1 KB
/
index.html
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
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
<!DOCTYPE html>
<html>
<head>
<title>Nanocloud documentation</title>
<link rel="stylesheet" href="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0-alpha.5/css/bootstrap.min.css" integrity="sha384-AysaV+vQoT3kOAXZkl02PThvDr8HYKPZhNT5h/CXfBThSRXQ6jW5DO2ekP5ViFdi" crossorigin="anonymous">
<script src="https://maxcdn.bootstrapcdn.com/bootstrap/4.0.0-alpha.5/js/bootstrap.min.js" integrity="sha384-BLiI7JTZm+JWlgKa0M0kGRpJbF2J8q+qreVrKBC47e3K6BW78kGLrCkeRX6I9RoK" crossorigin="anonymous"></script>
<link rel="stylesheet" type="text/css" href="style.css">
<link href="https://maxcdn.bootstrapcdn.com/font-awesome/4.7.0/css/font-awesome.min.css" rel="stylesheet" integrity="sha384-wvfXpqpZZVQGK6TAh5PVlGOfQNHSoD2xbE+QkPxCAFlNEevoEH3Sl0sibVcOQVnN" crossorigin="anonymous">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/9.9.0/styles/github.min.css">
</head>
<body>
<div class="container">
<div class="row">
<div class="col-md-3">
<div class="bootstrap-vertical-nav">
<nav class="navbar navbar-light">
<button class="navbar-toggler hidden-md-up" type="button" data-toggle="collapse" data-target="#exCollapsingNavbar2">
☰
</button>
<div class="collapse navbar-toggleable-sm" id="exCollapsingNavbar2">
<h1 class="title">Nanocloud documentation</h1>
<ul class="nav navbar-nav"><h4 class="menu-title">INSTALLATION</h4><li class="nav-item"><a class="nav-link" href="#target=prerequisites">Prerequisites</a></li><li class="nav-item"><a class="nav-link" href="#target=start-the-installation">Start the installation</a></li><li class="nav-item"><a class="nav-link" href="#target=optional-storage-configurations">Optional storage configurations</a></li><li class="nav-item"><a class="nav-link" href="#target=configuration-for-15-users">Configuration for 15 users</a></li><li class="nav-item"><a class="nav-link" href="#target=configure-nanocloud">Configure nanocloud</a></li><li class="nav-item"><a class="nav-link" href="#target=complete-the-installation">Complete the installation</a></li><h4 class="menu-title">GETTING STARTED</h4><li class="nav-item"><a class="nav-link" href="#target=introduction-to-nanocloud">Introduction to nanocloud</a></li><li class="nav-item"><a class="nav-link" href="#target=login">Login</a></li><li class="nav-item"><a class="nav-link" href="#target=dashboard">Dashboard</a></li><h4 class="menu-title">APPLICATIONS</h4><li class="nav-item"><a class="nav-link" href="#target=overview-of-the-applications-tab">Overview of the applications tab</a></li><li class="nav-item"><a class="nav-link" href="#target=launch-the-virtual-desktop-vdi">Launch the virtual desktop vdi</a></li><li class="nav-item"><a class="nav-link" href="#target=install-and-publish-an-application">Install and publish an application</a></li><li class="nav-item"><a class="nav-link" href="#target=launch-an-application">Launch an application</a></li><li class="nav-item"><a class="nav-link" href="#target=print-a-document-in-the-vdi">Print a document in the vdi</a></li><li class="nav-item"><a class="nav-link" href="#target=manage-an-image">Manage an image</a></li><li class="nav-item"><a class="nav-link" href="#target=manage-an-application">Manage an application</a></li><h4 class="menu-title">FILES</h4><li class="nav-item"><a class="nav-link" href="#target=overview-of-the-files-tab">Overview of the files tab</a></li><li class="nav-item"><a class="nav-link" href="#target=manage-files-in-the-vdi">Manage files in the vdi</a></li><li class="nav-item"><a class="nav-link" href="#target=manage-files-in-web-interface">Manage files in web interface</a></li><h4 class="menu-title">MACHINES</h4><li class="nav-item"><a class="nav-link" href="#target=overview-of-the-machines-tab">Overview of the machines tab</a></li><li class="nav-item"><a class="nav-link" href="#target=access-the-information-of-the-machine">Access the information of the machine</a></li><h4 class="menu-title">HISTORY</h4><li class="nav-item"><a class="nav-link" href="#target=overview-of-the-history-tab">Overview of the history tab</a></li><h4 class="menu-title">USERS</h4><li class="nav-item"><a class="nav-link" href="#target=overview-of-the-users-tab">Overview of the users tab</a></li><li class="nav-item"><a class="nav-link" href="#target=create-a-new-user">Create a new user</a></li><li class="nav-item"><a class="nav-link" href="#target=modify-the-users-information">Modify the users information</a></li><li class="nav-item"><a class="nav-link" href="#target=delete-a-user">Delete a user</a></li><li class="nav-item"><a class="nav-link" href="#target=create-a-new-group">Create a new group</a></li><li class="nav-item"><a class="nav-link" href="#target=add-remove-a-group-member">Add remove a group member</a></li><li class="nav-item"><a class="nav-link" href="#target=add-remove-an-application">Add remove an application</a></li><li class="nav-item"><a class="nav-link" href="#target=delete-a-group">Delete a group</a></li><li class="nav-item"><a class="nav-link" href="#target=rename-a-group">Rename a group</a></li><li class="nav-item"><a class="nav-link" href="#target=create-a-team">Create a team</a></li><li class="nav-item"><a class="nav-link" href="#target=manage-a-teams-files">Manage a teams files</a></li><h4 class="menu-title">PROFILE</h4><li class="nav-item"><a class="nav-link" href="#target=overview-of-the-profile-tab">Overview of the profile tab</a></li><li class="nav-item"><a class="nav-link" href="#target=modify-your-accounts-information">Modify your accounts information</a></li><h4 class="menu-title">CONFIGURATION</h4><li class="nav-item"><a class="nav-link" href="#target=overview-of-the-configuration-tab">Overview of the configuration tab</a></li><li class="nav-item"><a class="nav-link" href="#target=configure-sessions">Configure sessions</a></li><li class="nav-item"><a class="nav-link" href="#target=configure-user-rights">Configure user rights</a></li><li class="nav-item"><a class="nav-link" href="#target=configure-emails">Configure emails</a></li><li class="nav-item"><a class="nav-link" href="#target=configure-look-and-feel">Configure look and feel</a></li><li class="nav-item"><a class="nav-link" href="#target=configure-ldap">Configure ldap</a></li><li class="nav-item"><a class="nav-link" href="#target=other-settings">Other settings</a></li><h4 class="menu-title">BROKER LOG</h4><li class="nav-item"><a class="nav-link" href="#target=overview-of-the-broker-log-tab">Overview of the broker log tab</a></li></ul>
</div>
</nav>
</div>
</div>
<div class="col-md-9">
<div id="welcome" class="doc-page">
<div class="jumbotron page-title">
<h1 class="display-3">Nanocloud Software Documentation & Support</h1>
<hr class="my-2">
<p>Welcome to Nanocloud Software's documentation & support hub! You'll find comprehensive guides and documentation to help you start working with Nanocloud Software as quickly as possible, as well as support if you get stuck. Let's jump right in!</p>
<p class="lead">
<a class="btn btn-primary btn-lg" href="#target=prerequisites" role="button">Get started</a>
</p>
</div>
</div>
<div id="prerequisites" class="doc-page"><div class="page-title"><h1>Prerequisites</h1> <p class="lead"></p></div><hr><div class="alert alert-info" role="alert">
<strong>We highly recommend you to use Ubuntu 16.04 or Debian 8 to install Nanocloud.</strong><br />
</div><div class="alert alert-warning" role="alert">
<strong>The commands in all the procedures of all the installation are only valid for Ubuntu and Debian!</strong><br />
</div><p>Down below are listed the prerequisites for a successful installation of Nanocloud.</p>
<ul>
<li>You need a Linux server, no matter the distribution, although we highly recommend Ubuntu or Debian.</li>
</ul>
<ul>
<li>Login through ssh on the Linux machine.</li>
</ul>
<ul>
<li>Install vim, git and curl with the following command:</li>
</ul>
<pre><code class="sh">sudo apt-get update
sudo apt-get install -y vim git curl</code></pre><ul>
<li>Install Docker Compose 1.8.0 with the following commands:</li>
</ul>
<pre><code class="sh">curl -fsSL https://get.docker.com/ | sudo sh
curl -L https://github.com/docker/compose/releases/download/1.8.0/docker-compose-$(uname -s)-$(uname -m) > docker-compose
sudo cp docker-compose /usr/local/bin/docker-compose
sudo chmod +x /usr/local/bin/docker-compose</code></pre><ul>
<li>Add the user to the Docker group, with the following command:</li>
</ul>
<pre><code class="sh">sudo usermod -aG docker <username></code></pre><div class="alert alert-warning" role="alert">
<strong>After this last step, you must log in again.</strong><br /><p>Otherwise, the group change will not be taken into account.</p>
</div><div class="alert alert-success" role="alert">
<strong>Congratulations! You are now ready to start the installation of Nanocloud!</strong><br /><p><a href="#target=start-the-installation">Click here to start the installation</a>.</p>
</div></div><div id="start-the-installation" class="doc-page"><div class="page-title"><h1>Start the installation</h1> <p class="lead">The first part of the installation guides you from the downloading of Nanocloud's sources, to the choice of the version. It is mandatory.</p></div><hr><ol>
<li>Download Nanocloud's sources with the following command.</li>
</ol>
<pre><code class="sh">git clone https://github.com/Nanocloud/nanocloud.git</code></pre><ol start="2">
<li>Go into the nanocloud folder.</li>
</ol>
<ol start="3">
<li>Use the following command to obtain the list of all available versions:</li>
</ol>
<pre><code class="sh">git tag</code></pre><ol start="4">
<li>Use the following command to choose the version you want:</li>
</ol>
<pre><code class="sh">git checkout <Nanocloud version></code></pre><p>If you want, you can use the following command to verify the version that you have chosen.</p>
<pre><code class="sh">git status</code></pre><div class="alert alert-success" role="alert">
<strong>Great job!</strong><br /><p>Now, you can <a href="#target=optional-storage-configurations">continue the installation by configuring user and team storage</a> if you need to. If you do not, and in the case of an installation for 15+ users, <a href="#target=configuration-for-15-users">follow the procedure of this page</a>. If you do not either, directly <a href="#target=configure-nanocloud">go to the next mandatory step of the installation, which is to configure Nanocloud</a>.</p>
</div></div><div id="optional-storage-configurations" class="doc-page"><div class="page-title"><h1>Optional storage configurations</h1> <p class="lead">The second part of the installation is optional. It allows you to configure user storage and team storage.</p></div><hr><div class="alert alert-success" role="alert">
<p>At this point, you should have:</p>
<ol>
<li>Followed the prerequisites.</li>
<li>Followed the steps of the first part of the installation.</li>
</ol>
<p>You can now follow the steps below to configure user and/or team storages in Nanocloud!</p>
</div><h2>User storage</h2><div class="alert alert-warning" role="alert">
<strong>The procedure below is optional.</strong><br /><p>You need to figure out whether you need and want to create another VM.
You can use the original VM for the User Storage or you can create another VM dedicated to User Storage only.
If you do not need or want to create another VM, simply skip this procedure.</p>
</div><p>If you need or want to create another VM, dedicated to User Storage only:</p>
<ol>
<li>Create a new machine.</li>
</ol>
<div class="alert alert-info" role="alert">
<strong>Reminder: how to create a new machine</strong><br /><ol>
<li>Provision your machine.</li>
<li>Follow the steps of <a href="#target=prerequisites">Prerequisites</a>.</li>
<li>Clone Nanocloud's repository.</li>
</ol>
</div><ol start="2">
<li>Use the commands below:</li>
</ol>
<pre><code class="sh">docker-compose build plaza && docker-compose up -d plaza
docker-compose up -d storage</code></pre><h2>Team storage</h2><div class="alert alert-danger" role="alert">
<strong>Team Storage and User Storage must be in two different machines.</strong><br /><p>If you have already created a new machine and dedicated it to User Storage, please keep in mind that you cannot use that same machine for Team Storage. They must be in two separate machines.</p>
</div><div class="alert alert-warning" role="alert">
<strong>The procedure below is optional</strong><br /><p>You need to figure out whether you want to enable the creation of teams or not.
If you enable the creation of teams, you will need to create another VM entirely dedicated to Team Storage.
If you do not want to enable the creation of teams, simply skip this procedure.</p>
</div><p>To enable the creation of teams, by creating another VM dedicated to Teams Storage:</p>
<ol>
<li>Create a new machine.</li>
</ol>
<div class="alert alert-info" role="alert">
<strong>Reminder: how to create a new machine</strong><br /><ol>
<li>Provision your machine.</li>
<li>Follow the steps of <a href="#target=prerequisites">Prerequisites</a>.</li>
<li>Clone Nanocloud's repository</li>
</ol>
</div><ol start="2">
<li>Use the commands below:</li>
</ol>
<pre><code class="sh">docker-compose -f docker-compose-extra.yml build && docker-compose -f docker-compose-extra.yml up -d plaza
docker-compose -f docker-compose-extra.yml up -d storage-team</code></pre><div class="alert alert-success" role="alert">
<strong>Great job! You have successfully configured User and Team Storage in Nanocloud!</strong><br /><p>Now, continue the installation. If you install Nanocloud for more than 15 users, <a href="#target=configuration-for-15-users">click here</a>. If you do not, directly go to the step after that, which is mandatory, to <a href="#target=configure-nanocloud">configure Nanocloud</a>.</p>
</div></div><div id="configuration-for-15-users" class="doc-page"><div class="page-title"><h1>Configuration for 15+ users</h1> <p class="lead">The third part of the installation guides you to prepare Nanocloud to support 15+ users. It is only mandatory for those who need to install Nanocloud for 15+ users.</p></div><hr><div class="alert alert-success" role="alert">
<p>At this point, you should have:</p>
<ol>
<li>Followed the prerequisites.</li>
<li>Followed the steps of the first part of the installation.</li>
<li>(optional) Configured the storages.</li>
</ol>
<p>You can now follow the steps below to configure Nanocloud in order to enable it to support 15+ users!</p>
</div><div class="alert alert-warning" role="alert">
<strong>The procedure below is optional.</strong><br /><p>Obviously, if less than 15 users will use Nanocloud, you can skip this procedure and directly go to the next step, which is mandatory: <a href="#target=configure-nanocloud">configure Nanocloud</a>.</p>
</div><h2>Launching of the Video Engine Server container</h2><p>Use the following command to launch the Video Engine Server:</p>
<pre><code class="sh">docker-compose -f docker-compose-dev.yml up -d guacd</code></pre><p>The listening port will be 4822. To verify that the Video Engine Server container is listening on port 4822, use the following command:</p>
<pre><code class="sh">netstat -aptn</code></pre><p>Repeat these steps each time you create a new VM dedicated to Video Engine Server. Keep in mind that each new VM can support approximately 15 users. Therefore, you must follow the procedure above each time you want Nanocloud to be able to support approximately 15 more users.</p>
<h2>Creation of the Load Balancer on AWS</h2><p>For Nanocloud to be able to communicate with all your VMs, you need to create a load balancer on AWS.</p>
<ol>
<li>In the AWS website, select <strong>Services > EC2</strong>.</li>
</ol>
<ol start="2">
<li>In the <strong>Load Balancing</strong> section, click on <strong>Load Balancer</strong>.</li>
</ol>
<ol start="3">
<li>Click on the "Create load balancer" button.</li>
</ol>
<ol start="4">
<li>Choose to create a "Classic Load Balancer". Go to the next step.</li>
</ol>
<ol start="5">
<li>Fill in the fields to create your load balancer:</li>
</ol>
<ul>
<li>enter a name of your choice</li>
</ul>
<ul>
<li>choose a VPC</li>
</ul>
<ul>
<li>select the option "Create an internal load balancer"</li>
</ul>
<ul>
<li>in the table, enter the value of the correct port, which is "4822"</li>
</ul>
<p>Go the next step.</p>
<ol start="6">
<li>Add a security group. Go to the next step.</li>
</ol>
<ol start="7">
<li>To configure the health check, you just have to leave all the default values. Go to the next step.</li>
</ol>
<ol start="8">
<li>Add the EC2 instances, for the load balancer to communicate with the right VMs. Go to the next step.</li>
</ol>
<ol start="9">
<li>Add tags, which means that you can choose a name for your load balancer.</li>
</ol>
<p>To verify that the creation of the load balancer was successful:</p>
<ol>
<li>In AWS, select <strong>Load Balancer > Instance</strong>.</li>
</ol>
<ol start="2">
<li>Check that the status indicates "InService". If that is what is written, the creation of the load balancer was successful.</li>
</ol>
<div class="alert alert-success" role="alert">
<strong>Great job! You have successfully configured Nanocloud for it to support 15+ users!</strong><br /><p>Now, <a href="#target=configure-nanocloud">click here to go to the next step, which is mandatory: configure Nanocloud</a>!</p>
</div></div><div id="configure-nanocloud" class="doc-page"><div class="page-title"><h1>Configure Nanocloud</h1> <p class="lead">The fourth part of the installation of Nanocloud displays the different variables that you may need to configure Nanocloud. It is mandatory.</p></div><hr><div class="alert alert-success" role="alert">
<p>At this point, you should have:</p>
<ol>
<li>Followed the prerequisites.</li>
<li>Followed the steps of the first part of the installation.</li>
<li>(optional) Configured the storages.</li>
<li>(optional) Configured Nanocloud to support 15+ users.</li>
</ol>
<p>You can now follow the steps below to configure Nanocloud!</p>
</div><p>Edit the file config.env, which you will find in the Nanocloud directory. All the variables to configure are listed and explained down below.</p>
<div class="alert alert-danger" role="alert">
<strong>Comments in variables</strong><br /><p>Please note that the comments in the variables below are just here to explain you how each variable works. However, <strong>your must delete every comment when configuring the file config.env</strong>!</p>
</div><h2>Variables for the whole installation</h2>
<pre><code class="sh">IAAS=aws # MANDATORY VARIABLE - Choose between "manual", "aws" and "openstack"
HOST=localhost # MANDATORY VARIABLE (USED FOR SELF-REGISTRATION) - Defaults to localhost - Enter Nanocloud's IP or Nanocloud's domain name
EXPIRATION_DATE=30 # Defaults to 0 (deactivated) - Choose the default number of days before user account expiration
AUTO_REGISTER=true # Defaults to "false" - Choose if users can register themselves ("true") or not ("false")
DEFAULT_GROUP=2b35335b-a71b-4f36-bf27-427f9f8caaef # Defaults to empty string (no default group) - This variable depends on the AUTO_REGISTER one - Enter the UID of the default group for self-registered users
AUTO_LOGOFF=false # Defaults to "false" - Choose if you want VDI sessions to automatically sign off when the user leaves the VDI ("true") or not ("false")
MACHINE_POOL_SIZE=5 # Defaults to 1 - Choose the number of machines to provision in advance for users
MACHINES_NAME=Nanocloud Exec Server # Defaults to "Nanocloud Exec Server" - Choose a name for the machines
PLAZA_URI=https://s3-eu-west-1.amazonaws.com/nanocloud/plaza/1.0.0/windows/amd64/plaza.exe # Defaults to https://s3-eu-west-1.amazonaws.com/nanocloud/plaza/1.0.0/windows/amd64/plaza.exe - Choose a URL to download plaza from
PLAZA_PORT=9090 # Defaults to 9090 - Enter the port to communicate with plaza</code></pre><h2>SMTP configuration</h2>
<p>These variables are only relevant for two features: reset password and auto-registration.</p>
<pre><code class="sh">SMTP_SERVER_HOST=smtp.nanocloud.com # Choose a host to send emails - IP or domain name
SMTP_SERVER_PORT=25 # Defaults to 25 - Enter the port for the SMTP server
SMTP_LOGIN=Username # Enter the login for the SMTP server
SMTP_PASSWORD=Password # Enter a password for the SMTP server
[email protected] # Defaults to [email protected] - Enter the email address of Nanocloud's sender</code></pre><h2>Look and Feel</h2>
<pre><code class="sh">TITLE=Nanocloud # Defaults to "Nanocloud" - Choose a page title
FAV_ICON_PATH=favicon.ico # Defaults to favicon.ico - Enter a relative path from `assets/dist`
LOGO_PATH=`/assets/images/logo.png` # Defaults to `/assets/images/logo.png` - Enter a relative path from `assets/dist` (a URL works)
PRIMARY_COLOR=#A4DCD1 # Defaults to #006CB6 - Choose a primary color</code></pre><h2>AWS Driver</h2>
<p>These variables are for AWS users only.</p>
<pre><code class="sh">AWS_REGION=eu-central-1 # MANDATORY VARIABLE - Enter the name of the region where machines will spawn
AWS_ACCESS_KEY_ID=AccessKeyID # MANDATORY VARIABLE - Enter the AWS key ID
AWS_SECRET_ACCESS_KEY=SecretAccessKey # MANDATORY VARIABLE - Enter the AWS private key
AWS_KEY_NAME=Nanocloud01 # MANDATORY VARIABLE - Enter the name of the private key
AWS_PRIVATE_KEY=/opt/back/id_rsa # Defaults to "/opt/back/id_rsa" - Enter the path to where the key will be stored
AWS_IMAGE=ami-09e61366 # Defaults to "ami-09e61366" - Enter Nanocloud's execution servers default image - Note that AMI ID depends on the region
AWS_FLAVOR=t2.medium # Defaults to "t2.medium" - Enter the size of virtual machines
AWS_MACHINE_USERNAME=Administrator # Defaults to "Administrator" - Choose the name of the administrator account on the machine
CREDIT_LIMIT=10 # Defaults to empty string (no limit) - Set a credit limit to users (in dollars)</code></pre><h2>OpenStack Driver</h2>
<p>These variables are for OpenStack users only.</p>
<pre><code class="sh">OPENSTACK_USERNAME=Username # MANDATORY VARIABLE - Enter your username to connect to Openstack
OPENSTACK_PASSWORD=Password # MANDATORY VARIABLE - Enter your password to connect to Openstack
OPENSTACK_AUTH_URL=https://identity.example.com:5000 # MANDATORY VARIABLE - Enter the URL of the Openstack's API
OPENSTACK_REGION=RegionOne # MANDATORY VARIABLE - Enter the name of the region to use on Openstack
OPENSTACK_IMAGE=47131599-4b29-493a-86a0-56848e6529ff # MANDATORY VARIABLE - Choose an image to boot Windows execution servers from
OPENSTACK_FLAVOR=m1.medium # MANDATORY VARIABLE - Choose the flavor for the virtual machine
OPENSTACK_MACHINE_USERNAME=Administrator # Defaults to "Administrator" - Enter the username of the Windows' account
OPENSTACK_MACHINE_PASSWORD=Password # Defaults to empty, password will be generated - Enter the password of the Windows' account</code></pre><h2>Storage configuration</h2>
<pre><code class="sh">STORAGE_ADDRESS=localhost # MANDATORY VARIABLE - Defaults to "localhost" - Enter the storage service's IP (for user storage)
STORAGE_PORT=9090 # MANDATORY VARIABLE - Defaults to "9090" - Enter the storage service's port
UPLOAD_LIMIT=500 # MANDATORY VARIABLE - Defaults to 0 (deactivate) - Choose an upload limit, in MB, for each user
TEAM_STORAGE_ADDRESS=localhost # Default to "localhost" - Enter the IP address of the storage
TEAM_STORAGE_PORT=9091 # Default to "9091" - Enter the port of the team storage
TEAM_ENABLED=true # Default to "false" - Choose whether you want to enable the creation of teams ("true") or not ("false") </code></pre><h2>RDP/Guacamole options</h2>
<p>For more information about RDP/Guacamole options, please <a href="http://guacamole.incubator.apache.org/doc/gug/configuring-guacamole.html#rdp">check their own documentation</a>.</p>
<pre><code class="sh">RDP_SECURITY=nla # Nanocloud defaults to "nla"
RDP_IGNORE_CERT=true # Nanocloud defaults to "true"
RDP_WIDTH=0 # Nanocloud defaults to 0 (automatic)
RDP_HEIGHT=0 # Nanocloud defaults to 0 (automatic)
RDP_DPI=0 # Nanocloud defaults to 0 (automatic)
RDP_ENABLE_PRINTING=true # Nanocloud defaults to "true"
RDP_PRECONNECTION_ID=0 # Nanocloud defaults to 0 (desactivated)
RDP_ENABLE_WALLPAPER=true # Nanocloud defaults to "true"
RDP_ENABLE_FONT_SMOOTHING=true # Nanocloud defaults to "true"</code></pre><div class="alert alert-success" role="alert">
<strong>Great job! You have successfully configured Nanocloud!</strong><br /><p>Now, <a href="#target=complete-the-installation">click here to complete the installation</a>!</p>
</div></div><div id="complete-the-installation" class="doc-page"><div class="page-title"><h1>Complete the installation</h1> <p class="lead">The fifth and last part guides you to complete the installation of Nanocloud. Its is mandatory.</p></div><hr><div class="alert alert-success" role="alert">
<p>At this point, you should have:</p>
<ol>
<li>Followed the prerequisites.</li>
<li>Followed the steps of the first part of the installation.</li>
<li>(optional) Configured the storages.</li>
<li>(optional) Configured Nanocloud to support 15+ users.</li>
<li>Configured Nanocloud.</li>
</ol>
<p>You can now follow the steps below to complete the installation!</p>
</div><ol>
<li>Use the following command to build the container:</li>
</ol>
<pre><code class="sh">docker-compose build</code></pre><ol start="2">
<li>Use the following command for the container to be up:</li>
</ol>
<pre><code class="sh">docker-compose up -d</code></pre><div class="alert alert-success" role="alert">
<strong>Great job! You have successfully installed Nanocloud!</strong><br />
</div></div><div id="introduction-to-nanocloud" class="doc-page"><div class="page-title"><h1>Introduction to Nanocloud</h1> <p class="lead">This page gives insights on how the Nanocloud Platform is architectured: which kind of computing resources is need, which systems are used etc.</p></div><hr><p>Nanocloud Software platform is based on a multi-components architecture.</p>
<p>The core part is a set of containers (based on Docker technology) hosted in a Linux system which can be a bare-metal server or a virtual machine (VM). Each container is in charge of a Nanocloud Software module. These modules are a backend with a REST API, a database, an HTML5 frontend, and a HTTP/HTTPS web proxy.</p>
<p>Administrator and users can access to this platform through its web interface. Nanocloud Software is then also a gateway between the user's network (Internet, Enterprise Intranet, VPN) and the application used.</p>
<p>Any application transformed in a service available in a browser is hosted in another part of the architecture: one or a set of several Windows Server virtual machine(s), depending on the number of users and of the application type. This application server does not need to be connected to a public network, thanks to the Nanocloud platform which is in charge of the service exposure. Depending on the user needs, Nanocloud platform may also provide an access to a complete Virtual Desktop Interface (VDI).</p>
<img class="page-image" src="images/architecture_nanocloud_2.png" width="840" height="undefined"><p>The needed resources can be provisioned from a private cloud (based on Openstack) or from Amazon Web services (AWS).</p>
<p>Indeed, Nanocloud Software platform must be understood as a PaaS. It helps you to abstract the IaaS layer. Then, you don’t need any particular skill at the infrastructure low layer since Nanocloud is compatible with any available technology from private clouds or from public clouds.</p>
</div><div id="login" class="doc-page"><div class="page-title"><h1>Login</h1> <p class="lead"></p></div><hr><img class="page-image" src="images/login_page_220.png" width="678" height="undefined"><p>Once Nanocloud Software is installed, you can access it through a web interface. Depending on your installation, Nanocloud web interface is accessible with an URL displayed as:</p>
<ul>
<li>a local IP,</li>
</ul>
<ul>
<li>a public IP,</li>
</ul>
<ul>
<li>a domain name.</li>
</ul>
<div class="alert alert-info" role="alert">
<strong>Default protocol</strong><br /><p>The default protocol recommended by Nanocloud to access its platform is HTTPS (Secure HTTP).</p>
</div><div class="alert alert-info" role="alert">
<strong>Interface customization</strong><br /><p>Depending on your needs, the home page and all the other pages of the web interface can be customized with your enterprise logo or your trademark.
<em>Example: if you are a software editor, Nanocloud Software may be provided as a O.E.M. solution for your products with a redesigned interface according to your graphic charter.</em></p>
</div></div><div id="dashboard" class="doc-page"><div class="page-title"><h1>Dashboard</h1> <p class="lead"></p></div><hr><div class="alert alert-danger" role="alert">
<strong>The Dashboard tab is only available for administrators!</strong><br />
</div><img class="page-image" src="images/dashboard_220.png" width="677" height="undefined"><p>Once you have logged in, you can see your dashboard.</p>
<p>On the dashboard are displayed:</p>
<ul>
<li>the number of registered users,</li>
</ul>
<ul>
<li>the number of online users (using applications or a VDI),</li>
</ul>
<ul>
<li>the number of published applications,</li>
</ul>
<ul>
<li>the number of machines which are up,</li>
</ul>
<ul>
<li>the number of uploaded files,</li>
</ul>
<ul>
<li>the number of images.</li>
</ul>
</div><div id="overview-of-the-applications-tab" class="doc-page"><div class="page-title"><h1>Overview of the Applications tab</h1> <p class="lead"></p></div><hr><p>The Applications tab displays currently published applications, organized according to the image they belong to.</p>
<div class="alert alert-info" role="alert">
<strong>Reminder: what is an image</strong><br /><p>An image is the snapshot of a virtual environment used in the VDI.</p>
<p><strong>Images in Nanocloud:</strong></p>
<ul>
<li>You can publish your applications in several different images, to organize them.</li>
<li>Your users have access to specific images, in other words, to specific groups of applications.</li>
</ul>
</div><img class="page-image" src="images/applications_overview_220.png" width="678" height="undefined"><p><strong>DESKTOP</strong></p>
<p>The <strong>Desktop</strong> button is by default in every created image. Il gives access to the VDI.</p>
<p>You can use this button to <a href="#target=launch-the-virtual-desktop-vdi">Launch the Virtual Desktop (VDI)</a> and to <a href="#target=install-and-publish-an-application">Install and publish an application</a> if you are an administrator.</p>
</div><div id="launch-the-virtual-desktop-vdi" class="doc-page"><div class="page-title"><h1>Launch the Virtual Desktop (VDI)</h1> <p class="lead"></p></div><hr><p>In the Applications tab, click on the <strong>Desktop</strong> button in the image of your choice.</p>
<div class="alert alert-success" role="alert">
<strong>The VDI is launched within your browser!</strong><br /><p>A files browser opens automatically.</p>
</div><img class="page-image" src="images/VDI_launch_220.png" width="692" height="undefined"><p>Several buttons are available in the top bar:</p>
<ul>
<li><i class="fa fa-cloud-upload" aria-hidden="true"></i> <strong>Upload</strong>: dropdown menu listing the files uploaded from your local computer to the VDI</li>
</ul>
<ul>
<li><i class="fa fa-cloud-download" aria-hidden="true"></i> <strong>Download</strong>: dropdown menu listing the files downloaded in the VDI</li>
</ul>
<ul>
<li><i class="fa fa-clone" aria-hidden="true"></i> <strong>Clipboard</strong>: copy/paste interface</li>
</ul>
<ul>
<li><i class="fa fa-floppy-o" aria-hidden="true"></i> <strong>Save an image</strong>: to save an image of the VDI</li>
</ul>
<ul>
<li><i class="fa fa-plus-circle" aria-hidden="true"></i> <strong>Onboard an application</strong>: to publish an application</li>
</ul>
<ul>
<li><i class="fa fa-power-off" aria-hidden="true"></i> <strong>Disconnect</strong>: to disconnect from your Windows session</li>
</ul>
<ul>
<li><i class="fa fa-home" aria-hidden="true"></i> <strong>Home</strong>: to redirect you to the main portal while keeping your VDI session open in the background</li>
</ul>
<div class="alert alert-danger" role="alert">
<strong>Some buttons are only available for administrators!</strong><br /><p>If you are a regular user, you will not be able to use the following buttons:</p>
<ul>
<li><strong>Save an image</strong>,</li>
<li><strong>Onboard an application</strong>.</li>
</ul>
</div><h2>Copy and Paste</h2><img class="page-image" src="images/applications-copy-paste.png" width="486" height="undefined"><p>A copy and paste interface is available through the <i class="fa fa-clone" aria-hidden="true"></i> icon to exchange text from your local computer to the VDI, and vice-versa.</p>
<p><strong>To copy and paste text in the VDI:</strong></p>
<ol>
<li>Paste the text or write it in the provided area. Your text is automatically available in the VDI.</li>
</ol>
<ol start="2">
<li>Paste your text wherever you want, in the VDI.</li>
</ol>
<p><strong>To copy text from the VDI to paste it in your local computer:</strong></p>
<ol>
<li>Copy the text in your application, or in your VDI.</li>
</ol>
<ol start="2">
<li>Click on <i class="fa fa-clone" aria-hidden="true"></i> to open the copy/paste interface.</li>
</ol>
<ol start="3">
<li>Click on the text "<i class="fa fa-laptop" aria-hidden="true"></i> Copy clipboard to local". Your text is now available in your local computer.</li>
</ol>
<ol start="4">
<li>Paste your text wherever you want, in your local computer.</li>
</ol>
<div class="alert alert-info" role="alert">
<strong>Reminder for Mac users</strong><br /><p>If you are a Mac user, remember that when you are in the VDI, you use a Windows environment. This is why, to copy or paste text, you cannot use the shortcuts cmd+C and cmd+V. Instead, use the Windows shortcuts: ctrl+C to copy and ctrl+V to paste.</p>
</div><div class="alert alert-info" role="alert">
<strong>Easy copy/paste experience for Chrome users</strong><br /><p>If you want to make copy/paste much easier, you can download our Chrome Extension in the Chrome Web Store: <a href="https://chrome.google.com/webstore/detail/nanocloud-vdi-experience/bdajjbbhpglhkgdobcebedgajpfdncei">Nanocloud VDI Experience</a>. It allows you to copy and paste the traditional way, so you do not have to use the Clipboard interface.</p>
</div></div><div id="install-and-publish-an-application" class="doc-page"><div class="page-title"><h1>Install and publish an application</h1> <p class="lead"></p></div><hr><div class="alert alert-danger" role="alert">
<strong>This feature is only available for administrators!</strong><br />
</div><ol>
<li><a href="#target=launch-the-virtual-desktop-vdi">Launch the VDI</a>.</li>
</ol>
<ol start="2">
<li>Drag and drop the application installer from your local desktop to the VDI.</li>
</ol>
<ol start="3">
<li>In the VDI, open the <strong>Storage</strong> network location. Your application installer is inside.</li>
</ol>
<ol start="4">
<li>Install the application.</li>
</ol>
<div class="alert alert-info" role="alert">
<strong>Network Error: "Windows cannot access [...]"</strong><br /><p>If you cannot install the application because this message appears in your VDI, it is a permission related problem.
However, do not worry, we have a solution! Simply drag and drop your installer from the "Storage" network location to your VDI desktop. You can now install the application!</p>
</div><img class="page-image" src="images/VDI_application_install_220.png" width="678" height="undefined"><div class="alert alert-success" role="alert">
<strong>You have successfully installed your application!</strong><br />
</div><ol start="5">
<li>Once the application is installed, click <i class="fa fa-plus-circle" aria-hidden="true"></i> <strong>Onboard an application</strong> to publish it.</li>
</ol>
<ol start="6">
<li>Choose whether you want to save an image of the VDI or not. If you do so, wait a couple of minutes.</li>
</ol>
<ol start="7">
<li>A window appears on the right of the VDI. Browse through the files to find the application you just installed.</li>
</ol>
<ol start="8">
<li>Click the <strong>Publish it!</strong> button.</li>
</ol>
<img class="page-image" src="images/VDI_application_onboard_210.png" width="678" height="undefined"><div class="alert alert-success" role="alert">
<strong>Your application is published!</strong><br /><p>You can close the VDI and go back to the web interface. Your application is now listed in the list of applications of the image it belongs to.</p>
</div><img class="page-image" src="images/applications_overview_220.png" width="678" height="undefined"></div><div id="launch-an-application" class="doc-page"><div class="page-title"><h1>Launch an application</h1> <p class="lead"></p></div><hr><p>To launch a remote application, which means launching directly an application without opening the VDI first, simply click on the application’s name, in the applications list of the image it belongs to.</p>
<img class="page-image" src="images/VDI_application_launch_220.png" width="677" height="undefined"><div class="alert alert-success" role="alert">
<strong>Great job! You have launched a remote application!</strong><br />
</div></div><div id="print-a-document-in-the-vdi" class="doc-page"><div class="page-title"><h1>Print a document in the VDI</h1> <p class="lead"></p></div><hr><p>Any document (text file, presentation slides, graphics) edited in your remote application or in your VDI can be printed.</p>
<p>To do so:</p>
<ol>
<li>Click the Print button.</li>
</ol>
<ol start="2">
<li>Choose the Nanocloud printer. A PDF file is then downloaded to your browser.</li>
</ol>
</div><div id="manage-an-image" class="doc-page"><div class="page-title"><h1>Manage an image</h1> <p class="lead"></p></div><hr><div class="alert alert-danger" role="alert">
<strong>This feature is only available for administrators!</strong><br />
</div><p>In the Applications tab, click <i class="fa fa-search" aria-hidden="true"></i> to access the image's information. Each image information page displays:</p>
<ul>
<li>the image name,</li>
</ul>
<ul>
<li>the publication date,</li>
</ul>
<ul>
<li>the groups which have access to this image,</li>
</ul>
<ul>
<li>the UUID of the image,</li>
</ul>
<ul>
<li>the pool size of the image,</li>
</ul>
<ul>
<li>the size of the image's instances,</li>
</ul>
<ul>
<li>a button to delete the image.</li>
</ul>
<img class="page-image" src="images/image_information_220.png" width="679" height="undefined"><h2>Rename an image</h2><p>In some cases, it may be preferable to change the name of an application for your users, to display it in a more explicit way or to give the version of the software. As for images, it really is recommended to give them a proper, explicit name.</p>
<ol>
<li>Click <i class="fa fa-pencil" aria-hidden="true"></i> to enter in edition mode.</li>
</ol>
<ol start="2">
<li>Rename the application or the image in the provided area.</li>
</ol>
<ol start="3">
<li>Click <i class="fa fa-check" aria-hidden="true"></i> to validate your change.</li>
</ol>
<div class="alert alert-success" role="alert">
<strong>You have successfully renamed your image!</strong><br />
</div><h2>Change the pool size</h2><ol>
<li>In the Pool size section, click <i class="fa fa-pencil" aria-hidden="true"></i> to enter the edition mode.</li>
</ol>
<ol start="2">
<li>In the provided area, enter the size you want the pool of the image to be.</li>
</ol>
<ol start="3">
<li>Click <i class="fa fa-check" aria-hidden="true"></i> to validate your change.</li>
</ol>
<div class="alert alert-success" role="alert">
<strong>Great job! You changed your image's pool size!</strong><br />
</div><h2>Change the instances size</h2><p>Although the default instances size for all the images is managed in the Configuration tab, you can specifically change the instances size for each image.</p>
<p>To do so, in the Instances size section, you just have to check the size of your choice, between Small, Medium, Large and Very large. Your change is automatically taken into account.</p>
<div class="alert alert-success" role="alert">
<strong>Yay! You have changes the image's instances size!</strong><br />
</div><h2>Delete an image</h2><ol>
<li>Click the <strong>Delete this image</strong> button.</li>
</ol>
<ol start="2">
<li>Enter the name of the image to confirm its deletion.</li>
</ol>
<ol start="3">
<li>Click on the <strong>Delete image</strong> button.</li>
</ol>
<div class="alert alert-success" role="alert">
<strong>You have successfully deleted your image!</strong><br />
</div></div><div id="manage-an-application" class="doc-page"><div class="page-title"><h1>Manage an application</h1> <p class="lead"></p></div><hr><div class="alert alert-danger" role="alert">
<strong>This feature is only available for administrators!</strong><br />
</div><p>In the Applications tab, click <i class="fa fa-cog" aria-hidden="true"></i> to access the application's information. Each application information page displays:</p>
<ul>
<li>the application name,</li>
</ul>
<ul>
<li>the publication date,</li>
</ul>
<ul>
<li>the image the application belongs to,</li>
</ul>
<ul>
<li>the UUID of the application,</li>
</ul>
<ul>
<li>a button to delete the application.</li>
</ul>
<img class="page-image" src="images/applications_infos_220.png" width="677" height="undefined"><h2>Rename an application</h2><p>In some cases, it may be preferable to change the name of an application for your users, to display it in a more explicit way or to give the version of the software.</p>
<ol>
<li>Click <i class="fa fa-pencil" aria-hidden="true"></i> to enter in edition mode.u want to rename).</li>
</ol>
<ol start="2">
<li>Rename the application in the provided area.</li>
</ol>
<ol start="3">
<li>Click <i class="fa fa-check" aria-hidden="true"></i> to validate your change.</li>
</ol>
<div class="alert alert-success" role="alert">
<strong>Yay! You have renamed your application!</strong><br />
</div><h2>Delete an application</h2><ol>
<li>Click the <strong>Delete this application</strong> button.</li>
</ol>
<ol start="2">
<li>Enter the name of the application to confirm its deletion.</li>
</ol>
<ol start="3">
<li>Click on the <strong>Delete application</strong> button.</li>
</ol>
<div class="alert alert-success" role="alert">
<strong>You have successfully deleted your application!</strong><br />
</div></div><div id="overview-of-the-files-tab" class="doc-page"><div class="page-title"><h1>Overview of the Files tab</h1> <p class="lead"></p></div><hr><p>The Files tab displays the list of the uploaded files.</p>
<img class="page-image" src="images/files_overview_220.png" width="676" height="undefined"></div><div id="manage-files-in-the-vdi" class="doc-page"><div class="page-title"><h1>Manage files in the VDI</h1> <p class="lead"></p></div><hr><p>In the VDI, several options are available to manage files.</p>
<p>From the top bar in the VDI, you can:</p>
<ul>
<li>use <i class="fa fa-cloud-upload" aria-hidden="true"></i> to see the files uploaded from your local computer to the VDI</li>
</ul>
<img class="page-image" src="images/files-upload.png" width="336" height="undefined"><ul>
<li>use <i class="fa fa-cloud-download" aria-hidden="true"></i> to see the files downloaded in the VDI, and download them in your local computer by clicking <i class="fa fa-download" aria-hidden="true"></i></li>
</ul>
<img class="page-image" src="images/files-download.png" width="335" height="undefined"><div class="alert alert-info" role="alert">
<p>You can drag and drop any of your local files in the VDI, to upload it into the VDI.</p>
</div></div><div id="manage-files-in-web-interface" class="doc-page"><div class="page-title"><h1>Manage files in web interface</h1> <p class="lead"></p></div><hr><h2>Upload a file</h2><p>Once you are in the Files tab, you can upload a file in two different ways.</p>
<p><strong>Through the files browser</strong></p>
<ol>
<li>Click the link on the text "You can upload a file with drag and drop!". The files browser opens.</li>
</ol>
<ol start="2">
<li>Browse through your files to choose the one you want to upload.</li>
</ol>
<ol start="3">
<li>Click the <strong>Open</strong> button.</li>
</ol>
<p><strong>Drag and Drop</strong></p>
<p>You simply have to drag and drop a file into the interface.</p>
<div class="alert alert-success" role="alert">
<strong>Your file is uploaded!</strong><br />
</div><div class="alert alert-info" role="alert">
<strong>Uploaded files in the VDI</strong><br /><p>A “Storage” network location is created for any user, including the administrator, in the VDI. All the files listed in the “Files” tab are located in this network location.
If you want to download any file from your VDI in the cloud, just put it in Storage, when you are in your VDI.</p>
</div><h2>Download a file</h2><ol>
<li>In the files list, choose the file you want to download.</li>
</ol>
<ol start="2">
<li>Click <i class="fa fa-upload" aria-hidden="true"></i> .</li>
</ol>
<div class="alert alert-success" role="alert">
<strong>You have downloaded your file!</strong><br />
</div></div><div id="overview-of-the-machines-tab" class="doc-page"><div class="page-title"><h1>Overview of the Machines tab</h1> <p class="lead"></p></div><hr><p>The Machines lists and gives information on the virtual machines that are available to host your applications. The VMs, which are application servers, can be hosted in a public cloud or within your infrastructure.</p>
<img class="page-image" src="images/machines_overview_220.png" width="678" height="undefined"><h2>Machine status</h2><p>The dots in the "Status" column of the table indicate the connection status of the machines.</p>
<ul>
<li>Green dot: the VM is currently running.</li>
</ul>
<ul>
<li>Orange dot: the VM is booting.</li>
</ul>
</div><div id="access-the-information-of-the-machine" class="doc-page"><div class="page-title"><h1>Access the information of the Machine</h1> <p class="lead"></p></div><hr><div class="alert alert-danger" role="alert">
<strong>This feature is only available for administrators!</strong><br />
</div><img class="page-image" src="images/machines_infos_220.png" width="677" height="undefined"><p>Click the name of the machine to access its information:</p>
<ul>
<li>IP</li>
</ul>
<ul>
<li>Image</li>
</ul>
<ul>
<li>Driver: driver detected, depending on the Cloud platform you use</li>
</ul>
<ul>
<li>Machine size</li>
</ul>
<ul>
<li>Assigned user: user assigned to the machine</li>
</ul>
<p>You can also click on the <strong>Reboot</strong> button to reboot the machine, in case there is any problem.</p>
</div><div id="overview-of-the-history-tab" class="doc-page"><div class="page-title"><h1>Overview of the History tab</h1> <p class="lead"></p></div><hr><div class="alert alert-danger" role="alert">
<strong>The History tab is only available for administrators!</strong><br />
</div><p>The History tab records all sessions, for every user.</p>
<img class="page-image" src="images/history_overview_220.png" width="677" height="undefined"><p>The history gives several other information:</p>
<ul>
<li>User who launched the session</li>
</ul>
<ul>
<li>Application launched</li>
</ul>
<ul>
<li>Driver</li>
</ul>
<ul>
<li>Machine ID</li>
</ul>
<ul>
<li>Size of the Machine</li>
</ul>
<ul>
<li>Start date of each session</li>
</ul>
<ul>
<li>End date of each session</li>
</ul>
<ul>
<li>Total duration of the session</li>
</ul>
<p>You can also see how long is the average duration of the session and the total number of sessions.</p>
<div class="alert alert-info" role="alert">
<strong>Save the history as a CSV file</strong><br /><p>You can download the entire history record, in a CSV format.
Click the "Save as CSV file" button to download it.</p>
</div></div><div id="overview-of-the-users-tab" class="doc-page"><div class="page-title"><h1>Overview of the Users tab</h1> <p class="lead"></p></div><hr><div class="alert alert-danger" role="alert">
<strong>The Users tab is only available for administrators!</strong><br />
</div><p>The Users tab is composed of three different sub-tabs: Users, Groups and Teams (which is optional).</p>
<h2>Users</h2><p>In the Users tab, you can <a href="#target=create-a-new-user">create</a>, <a href="#target=modify-the-users-information">edit</a> and <a href="#target=delete-a-user">delete</a> a user.</p>
<p>The Users tab displays the list of registered users, including the administrators.</p>
<p>For each registered user, the information below are listed:</p>
<ul>
<li>Name: first name and last name</li>
</ul>
<ul>
<li>Email: which is also the ID to login</li>
</ul>
<ul>
<li>Type of user: Administrator or Regular user</li>
</ul>
<ul>
<li>Connection status: the dot is grey when the user does not use a VM at the moment, and green when the user uses a VM</li>
</ul>
<ul>
<li>(optional) Team: name of the team the user belongs to</li>
</ul>
<img class="page-image" src="images/users_overview_220.png" width="676" height="undefined"><h2>Groups</h2><p>In the Groups tab, you can <a href="#target=create-a-new-group">create groups</a>, <a href="#target=add-remove-an-application">add and remove applications from groups</a>, <a href="#target=add-remove-a-group-member">add and remove groups members</a>, and also <a href="#target=delete-a-group">delete groups</a>.</p>
<p>The Groups tab displays the list of users groups, as well as:</p>
<ul>
<li>the number of users in the group</li>
</ul>
<ul>
<li>the number of images available for this group</li>
</ul>
<p>Groups are intended to manage the users rights to access applications. You can create a pool of applications only available for a given set of users.</p>
<p><em>Example: you can create a group for developers, a group for current users, a group for sales demonstrations and a group for customers or for partners. The possibilities are endless!</em></p>
<img class="page-image" src="images/groups_overview_220.png" width="677" height="undefined"><h2>Teams</h2><div class="alert alert-info" role="alert">
<strong>Teams are optional.</strong><br /><p>You can activate or deactivate this feature in the <a href="#target=configure-user-rights">User rights</a> section of the Configuration tab.</p>
</div><p>In the Teams tab, you can <a href="#target=create-a-team">create and manage teams</a> and <a href="#target=manage-a-teams-files">manage a team's files</a>.</p>
<p>How teams function on Nanocloud is very simple.</p>
<p>Any user can create a team and add members to this team. Then, from the VDI, the members of the same team will be able to share files that them only will view and manage.</p>
<img class="page-image" src="images/teams_overview_220.png" width="767" height="undefined"></div><div id="create-a-new-user" class="doc-page"><div class="page-title"><h1>Create a new user</h1> <p class="lead"></p></div><hr><div class="alert alert-danger" role="alert">
<strong>This feature is only available for administrators!</strong><br />
</div><ol>
<li>In the Users tab, click on <strong>Add user</strong>.</li>
</ol>
<ol start="2">
<li>Fill in all the fields of the form.</li>
</ol>
<ol start="3">
<li>Click on <strong>create</strong>.</li>
</ol>
<div class="alert alert-info" role="alert">
<p>Security policy of the Nanocloud platform requires at least 8 characters for any new password.</p>
</div><img class="page-image" src="images/users_creation_220.png" width="678" height="undefined"><div class="alert alert-success" role="alert">
<strong>The new user is created!</strong><br /><p>The new user is now listed in the list of users.</p>
</div></div><div id="modify-the-users-information" class="doc-page"><div class="page-title"><h1>Modify the user's information</h1> <p class="lead">This page guides you to change the name, email address or password of a user.</p></div><hr><div class="alert alert-danger" role="alert">
<strong>This feature is only available for administrators!</strong><br />
</div><img class="page-image" src="images/users_infos_220.png" width="676" height="undefined"><h2>Modify the first or last name of a user</h2><ol>
<li>In the list of users, click the name of the user you want to edit.</li>
</ol>
<ol start="2">
<li>Click <i class="fa fa-pencil" aria-hidden="true"></i> next to the first or last name of the user. You enter in edition mode.</li>
</ol>
<ol start="2">
<li>Modify the user's first or last name.</li>
</ol>
<ol start="3">
<li>Click <i class="fa fa-check" aria-hidden="true"></i> to validate your changes.</li>
</ol>
<div class="alert alert-success" role="alert">
<strong>You successfully changed the user's name!</strong><br />
</div><h2>Modify the email address of a user</h2><ol>
<li>In the list of users, click the name of the user you want to edit.</li>
</ol>
<ol start="2">
<li>Click <i class="fa fa-pencil" aria-hidden="true"></i> next to the email address of the user. You enter in edition mode.</li>
</ol>
<ol start="2">
<li>Modify the user's email address.</li>
</ol>
<ol start="3">
<li>Click <i class="fa fa-check" aria-hidden="true"></i> to validate your changes.</li>
</ol>
<div class="alert alert-success" role="alert">
<strong>You successfully changed the user's email address!</strong><br />
</div><h2>Modify the password of a user</h2><ol>
<li>In the list of users, click the name of the user you want to edit.</li>
</ol>
<ol start="2">
<li>Click <i class="fa fa-pencil" aria-hidden="true"></i> on the right of the user's current password. You enter in edition mode.</li>
</ol>
<ol start="3">
<li>Enter the new password twice.</li>
</ol>
<ol start="4">
<li>Click <i class="fa fa-check" aria-hidden="true"></i> to validate your changes.</li>
</ol>
<div class="alert alert-success" role="alert">
<strong>The user has a new password!</strong><br />
</div><h2>Modify the expiration date of a user</h2><ol>
<li>In the list of users, click the name of the user you want to edit.</li>
</ol>
<ol start="2">
<li>Click <i class="fa fa-pencil" aria-hidden="true"></i> next to the current expiration date. You enter in edition mode.</li>
</ol>
<ol start="3">
<li>Enter the number of remaining days before the account expires.</li>
</ol>
<ol start="4">
<li>Click <i class="fa fa-check" aria-hidden="true"></i> to validate your changes.</li>
</ol>
<div class="alert alert-success" role="alert">
<strong>You have successfully modified the expiration date!</strong><br />
</div><h2>Modify the status of a user</h2><p>You can change the status of a user to make the user an administrator or on the contrary, to make an administrator become a regular user.</p>
<ol>
<li>In the list of users, click the name of the user you want to edit.</li>
</ol>
<ol start="2">
<li>Tick or untick the "Is admin" box.</li>
</ol>
<div class="alert alert-success" role="alert">
<strong>The user has a new status!</strong><br />
</div></div><div id="delete-a-user" class="doc-page"><div class="page-title"><h1>Delete a user</h1> <p class="lead"></p></div><hr><div class="alert alert-danger" role="alert">
<strong>This feature is only available for administrators!</strong><br />
</div><ol>
<li>In the list of users, click the name of the user you want to delete.</li>
</ol>
<ol start="2">
<li>Click the <strong>Delete this account</strong> button.</li>
</ol>
<ol start="3">
<li>Answer to a <strong>Yes/No</strong> question to confirm the deletion of your user.</li>
</ol>
<img class="page-image" src="images/users-deleteuser-2.0.0.png" width="802" height="undefined"><div class="alert alert-success" role="alert">
<strong>The user is deleted!</strong><br />
</div></div><div id="create-a-new-group" class="doc-page"><div class="page-title"><h1>Create a new group</h1> <p class="lead"></p></div><hr><div class="alert alert-danger" role="alert">
<strong>This feature is only available for administrators!</strong><br />
</div><ol>
<li>In the Groups tab, click on <strong>Create a group</strong>.</li>
</ol>
<ol start="2">
<li>Enter a name for your new group.</li>
</ol>
<ol start="3">
<li>Click on the <strong>Create</strong> button.</li>
</ol>
<img class="page-image" src="images/groups_creation_220.png" width="677" height="undefined"><div class="alert alert-success" role="alert">
<strong>Your new group is created!</strong><br /><p>The new group is now displayed in the Groups list. However, it has no applications and no members yet.</p>
</div></div><div id="add-remove-a-group-member" class="doc-page"><div class="page-title"><h1>Manage group members</h1> <p class="lead"></p></div><hr><div class="alert alert-danger" role="alert">
<strong>This feature is only available for administrators!</strong><br />
</div><img class="page-image" src="images/groups_members_220.png" width="677" height="undefined"><h2>Add a member to a group</h2><ol>
<li>In the Groups tab, click on the name of the group you want to add a member to.</li>
</ol>
<ol start="2">
<li>Click on the <strong>Members</strong> tab to manage users.</li>
</ol>
<ol start="3">
<li>Click on <strong>+</strong> next to the name of the user you want to add to the group.</li>
</ol>
<div class="alert alert-success" role="alert">
<strong>The user is added in the group!</strong><br />
</div><h2>Remove a member from a group</h2><ol>
<li>In the Groups tab, click on the name of the group you want to remove a member from.</li>
</ol>
<ol start="2">
<li>Click on the <strong>Members</strong> tab to manage users.</li>
</ol>
<ol start="3">
<li>Click on the check sign next to the name of the user you want to remove from the group.</li>
</ol>
<div class="alert alert-success" role="alert">
<strong>The user is no longer in the group!</strong><br />
</div></div><div id="add-remove-an-application" class="doc-page"><div class="page-title"><h1>Manage images in groups</h1> <p class="lead"></p></div><hr><div class="alert alert-danger" role="alert">
<strong>This feature is only available for administrators!</strong><br />
</div><img class="page-image" src="images/groups_applications_220.png" width="676" height="undefined"><h2>Add an image to a group</h2><ol>
<li>In the Groups tab, click on the name of the group you want to add an image to.</li>
</ol>
<ol start="2">
<li>Click on the <strong>Images</strong> tab to manage applications.</li>
</ol>
<ol start="3">
<li>Click on <strong>+</strong> next to the name of the image you want to add to the group.</li>
</ol>
<ol start="4">
<li>You can also deselect some applications from the image if you do not want your users to access them.</li>
</ol>
<div class="alert alert-success" role="alert">
<strong>The image is added to the group!</strong><br />
</div><h2>Remove an image from a group</h2><ol>
<li>In the Groups tab, click on the name of the group you want to remove an image from.</li>
</ol>
<ol start="2">
<li>Click on the <strong>Images</strong> tab to manage images.</li>
</ol>
<ol start="3">
<li>Click on the check sign next to the name of the image you want to remove from the group.</li>
</ol>
<div class="alert alert-success" role="alert">
<strong>The image is no longer available for the group!</strong><br />
</div></div><div id="delete-a-group" class="doc-page"><div class="page-title"><h1>Delete a group</h1> <p class="lead"></p></div><hr><div class="alert alert-danger" role="alert">
<strong>This feature is only available for administrators!</strong><br />
</div><p>If a group is no more needed, or if it is easier to create a new one instead of editing an existing one, you can simply delete it.</p>
<ol>
<li>In the Groups tab, click the name of the group you want to delete.</li>
</ol>
<ol start="2">
<li>Click the <strong>Delete this group</strong> button.</li>
</ol>
<ol start="3">
<li>Enter the name of the group to confirm its deletion.</li>
</ol>
<ol start="4">
<li>Click on the <strong>Delete group</strong> button.</li>
</ol>
<img class="page-image" src="images/groups_deletion_220.png" width="676" height="undefined"><div class="alert alert-success" role="alert">
<strong>The group is deleted!</strong><br /><p>The group is not listed in the groups list anymore.</p>
</div></div><div id="rename-a-group" class="doc-page"><div class="page-title"><h1>Rename a group</h1> <p class="lead"></p></div><hr><div class="alert alert-danger" role="alert">
<strong>This feature is only available for administrators!</strong><br />
</div><ol>
<li>In the Groups tab, click the name of the group you want to rename.</li>
</ol>
<ol start="2">
<li>Enter the new name of the group.</li>
</ol>
<ol start="3">
<li>Click on the <strong>Rename</strong> button.</li>
</ol>
<img class="page-image" src="images/groups_rename_220.png" width="677" height="undefined"><div class="alert alert-success" role="alert">
<strong>You have successfully renamed the group!</strong><br />
</div></div><div id="create-a-team" class="doc-page"><div class="page-title"><h1>Create a team</h1> <p class="lead"></p></div><hr><h2>Create a team</h2><ol>
<li>In the Teams tab, enter the name of your team in the provided area.</li>
</ol>
<ol start="2">
<li>Click on the <strong>Create</strong> button.</li>
</ol>
<div class="alert alert-danger" role="alert">
<strong>Each user can only create one team!</strong><br /><p>Once the user has created a team, it cannot be deleted, and no other team can be created by the same user.</p>
</div><img class="page-image" src="images/teams_creation_220.png" width="677" height="undefined"><div class="alert alert-success" role="alert">
<strong>Congratulations! You have created your team!</strong><br />
</div><h2>Add members to a team</h2><p>You can now add members to your team.</p>
<ol>
<li>Click on <strong>Create a new user</strong>.</li>
</ol>
<ol start="2">
<li>Fill in all the fields of the form.</li>
</ol>
<ol start="3">
<li>Click on <strong>Create</strong>.</li>
</ol>
<img class="page-image" src="images/teams_addmember_220.png" width="679" height="undefined"><div class="alert alert-success" role="alert">
<strong>Great job! You have added members to your team!</strong><br /><p>The users you add in your team automatically receive an email to confirm the creation of their account.</p>
</div></div><div id="manage-a-teams-files" class="doc-page"><div class="page-title"><h1>Manage a team's files</h1> <p class="lead"></p></div><hr><p>In the <strong>Team files</strong> section, you can view all the files shared between the different members of the team you administrate and/or belong to.</p>
<img class="page-image" src="images/teams_overview_220.png" width="767" height="undefined"><p>You can also organize and navigate through your files:</p>
<ul>
<li>Click on <i class="fa fa-plus" aria-hidden="true"></i> <strong>New folder</strong> to create a folder.</li>
</ul>
<ul>
<li>Click on <i class="fa fa-chevron-left" aria-hidden="true"></i> and <i class="fa fa-chevron-right" aria-hidden="true"></i> to navigate through your folders and files.</li>
</ul>
<ul>
<li>Click on <i class="fa fa-pencil" aria-hidden="true"></i> to rename your files.</li>
</ul>
<ul>
<li>Move your files with a simple drag-and-drop.</li>
</ul>
</div><div id="overview-of-the-profile-tab" class="doc-page"><div class="page-title"><h1>Overview of the Profile tab</h1> <p class="lead"></p></div><hr><div class="alert alert-danger" role="alert">
<strong>The Profile tab is only available for users!</strong><br />
</div><img class="page-image" src="images/profile_overview_220.png" width="677" height="undefined"><p>The Profile tab lists your account's information:</p>
<ul>
<li>First name</li>
</ul>
<ul>
<li>Last name</li>
</ul>
<ul>
<li>Email address</li>
</ul>
<ul>
<li>Password</li>
</ul>
<ul>
<li>Group you belong to</li>
</ul>
<ul>
<li>Expiration date of the account (optional)</li>
</ul>
<ul>
<li>Amount of credits used (optional)</li>
</ul>
<ul>
<li>Date of the creation of the account</li>
</ul>
<p>This tab allows you to modify your name, email address and password.</p>
</div><div id="modify-your-accounts-information" class="doc-page"><div class="page-title"><h1>Modify your account's information</h1> <p class="lead">This page guides you to change your name, email address or password, as a user.</p></div><hr><div class="alert alert-danger" role="alert">
<strong>This feature is only available for users!</strong><br />
</div><img class="page-image" src="images/profile_overview_220.png" width="677" height="undefined"><h2>Modify your first or last name</h2><ol>
<li>Click <i class="fa fa-pencil" aria-hidden="true"></i>. You enter in edition mode.</li>
</ol>
<ol start="2">
<li>Modify your first or last name.</li>
</ol>
<ol start="3">
<li>Click <i class="fa fa-check" aria-hidden="true"></i> to validate your changes.</li>