-
Notifications
You must be signed in to change notification settings - Fork 4
/
start.html
1459 lines (1391 loc) · 98.5 KB
/
start.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>
<!--[if IE 8]>
<html lang="en" class="ie8"> <![endif]-->
<!--[if IE 9]>
<html lang="en" class="ie9"> <![endif]-->
<!--[if !IE]><!-->
<html lang="en"> <!--<![endif]-->
<head>
<title>Nosqlclient Documentation - Quick Start</title>
<!-- Meta -->
<meta charset="utf-8">
<meta http-equiv="X-UA-Compatible" content="IE=edge">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="description" content="">
<meta name="author" content="">
<link rel="shortcut icon" href="favicon.ico">
<link href='https://fonts.googleapis.com/css?family=Open+Sans:300italic,400italic,600italic,700italic,800italic,400,300,600,700,800'
rel='stylesheet' type='text/css'>
<!-- Global CSS -->
<link rel="stylesheet" href="assets/plugins/bootstrap/css/bootstrap.min.css">
<!-- Plugins CSS -->
<link rel="stylesheet" href="assets/plugins/font-awesome/css/font-awesome.css">
<link rel="stylesheet" href="assets/plugins/prism/prism.css">
<link rel="stylesheet" href="assets/plugins/elegant_font/css/style.css">
<!-- Theme CSS -->
<link id="theme-style" rel="stylesheet" href="assets/css/styles.css">
<!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries -->
<!--[if lt IE 9]>
<script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script>
<script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script>
<![endif]-->
</head>
<body class="body-green">
<div class="page-wrapper">
<!-- ******Header****** -->
<header id="header" class="header">
<div class="container">
<div class="branding">
<h1 class="logo">
<a href="index.html">
<span aria-hidden="true" class="icon_documents_alt icon"></span>
<span class="text-highlight">Nosql</span><span class="text-bold">Client</span>
</a>
</h1>
</div><!--//branding-->
<ol class="breadcrumb">
<li><a href="index.html">Home</a></li>
<li class="active">Quick Start</li>
</ol>
</div><!--//container-->
</header><!--//header-->
<div class="doc-wrapper">
<div class="container">
<div id="doc-header" class="doc-header text-center">
<h1 class="doc-title"><i class="icon fa fa-paper-plane"></i> Quick Start</h1>
<div class="meta"><i class="fa fa-clock-o"></i> Version 2.2.0</div>
</div><!--//doc-header-->
<div class="doc-body">
<div class="doc-content">
<div class="content-inner">
<section id="download-section" class="doc-section">
<h2 class="section-title">Download</h2>
<div class="section-block">
<p>
Desktop distributions are electron applications and you can start
Nosqlclient without installation thanks to electron. But desktop distributions come
with pre-packaged <b>MongoDB</b> and <b>NodeJS</b> within them, that sometimes
causes trouble. Feel free to open an issue on github if you encounter one. <b>It's
recommended to use
desktop distributions
if
you're a new developer and don't
want to do anything else but a few clicks.</b>
<br/>
But if you already have <b>docker</b>, it's better to use <b>docker build</b>, so
that you can use latest features all the time, and docker isolates containers from
your environment.
</p>
<a class="btn btn-green btn-cta"
href="https://github.com/nosqlclient/nosqlclient/releases/latest"
target="_blank"><i
class="fa fa-download"></i> Desktop App</a>
<a style="margin-left: 5px" class="btn btn-green btn-cta" href="#docker"
target="_self"><i
class="fa fa-file-text"></i> Docker</a>
<a style="margin-left: 5px" class="btn btn-green btn-cta" href="#compile"
target="_self"><i
class="fa fa-file-text"></i> Web (Compile)</a>
</div>
</section><!--//doc-section-->
<section id="features-section" class="doc-section">
<h2 class="section-title">Pricing & Features</h2>
<div class="section-block">
<p>
No worries, Nosqlclient is <b>completely free, open-source and it will be
forever</b>.
But if you need an <b>in-house deployment, special feature implementation or
enterprise
support</b>
just contact with us by sending a mail to <a href="mailto:[email protected]">[email protected]</a>
</p>
<div class="row">
<div class="col-md-12 col-sm-12 col-xs-12">
<h6>Features</h6>
<ul class="list">
<li>Supports <b>LDAP, Kerberos (GSSAPI)</b> enterprise authentications
</li>
<li>Beginner helper query wizard</li>
<li>Live charts for active collection read/write operations</li>
<li>Live monitoring for memory and database statistics</li>
<li>Smart mongodb shell with auto completion</li>
<li>Supports <b>X509</b> authentication</li>
<li>SSH tunneling</li>
<li><b>In-place</b> data update, insert</li>
<li>Export result set as JSON, CSV</li>
<li>Import <b>mongoexport</b> results</li>
<li>Database dump/restore</li>
<li>User management from an intuitive UI without queries</li>
<li>File (<b>GridFS</b>) management from an intuitive UI without queries
</li>
<li>Index management from an intuitive UI without queries</li>
<li>Aggregation pipeline tool, drag & drop stages between your pipeline
list
</li>
<li>Supports extended JSON</li>
<li>Manage stored functions</li>
<li>Multiple result views with keeping their history and query style</li>
<li>Schema analyzer (using variety.js)</li>
<li>Field auto completion for queries</li>
<li>Supports <b>SCRAM_SHA_1 and MONGODB_CR</b> authentications</li>
</ul>
</div>
</div>
<div class="row">
<div class="col-md-12 col-sm-12 col-xs-12">
<h6>Enterprise Features</h6>
<ul class="list">
<li>Save live monitoring data for later use
</li>
<li>Email notification for per incident (RAM, CPU usage) for the specified
levels
</li>
<li>Performance analyzer</li>
<li><b>Save & Share</b> your queries with your teammates with only single
link.
</li>
<li>Manage <b>replica sets & shard clusters</b> from an intuitive GUI</li>
<li>Save aggregation tool's queries for later use</li>
<li>Data comparision between collections & databases</li>
<li>Priority support response time (2 business days)</li>
<li><a href="mailto:[email protected]">Contact us</a> for more...</li>
</ul>
</div>
</div>
</div>
</section><!--//doc-section-->
<section id="installation-section" class="doc-section">
<h2 class="section-title">Installation</h2>
<div id="docker" class="section-block">
<h3 class="block-title">Docker</h3>
<div class="row">
<div class="col-md-12 col-sm-12 col-xs-12">
<h6>TL;DR</h6>
<code>docker run -d -p 3000:3000 -v <path>:/data/db
mongoclient/mongoclient</code>
</div>
</div>
<div style="margin-top: 30px" class="row">
<div class="col-md-12 col-sm-12 col-xs-12">
<p>Docker is one of the best ways to quickly start using a Nosqlclient instance.
Nosqlclient offers a pre-built docker container which you can just pull and
start using. The
container
depends below frameworks, but you don't have to explicitly setup these, it
comes
with these frameworks.
</p>
<p>Also since it isolates your environment from container it gives you to
advantage of using Nosqlclient regardless of your system and hosting service
(AWS, Digital Ocean etc...)</p>
<p>Inside of image, there's a new user named <b>node</b>, to apply best
practices of docker (not starting with root) node user is capable of
managing mongodb that's installed to inside of container as well as managing
built Nosqlclient application</p>
</div>
</div>
<div class="row">
<div class="col-md-12 col-sm-12 col-xs-12">
<h6>Dependencies</h6>
<ul class="list">
<li>Debian 8 as base image
<ul>
<li>curl</li>
<li>ca-certificates</li>
<li>bzip2</li>
<li>build-essential</li>
<li>numactl</li>
<li>python</li>
<li>git</li>
<li>wget (to get gosu)</li>
<li><a target="_blank"
href="https://github.com/tianon/gosu">gosu</a></li>
</ul>
</li>
<li><a href="https://nodejs.org/en/">NodeJS</a> >= 4.7.3</li>
<li><a href="https://www.mongodb.com/">MongoDB</a> >= 3.4.2</li>
<li><a href="https://www.meteor.com/">MeteorJS</a> >= 1.4.3.2</li>
</ul>
</div>
</div>
<p>The container itself comes along with its dependencies, but you can define some of
them explicitly with environment variables</p>
<div class="row">
<div class="col-md-12 col-sm-12 col-xs-12">
<h6>Environment Variables</h6>
<div class="table-responsive">
<table class="table">
<thead>
<tr>
<th>#</th>
<th>Variable</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th scope="row">1</th>
<td>ROOT_URL</td>
<td>Useful to start nosqlclient from another base URL, <b>by default
uses root</b></td>
</tr>
<tr>
<th scope="row">2</th>
<td>MONGO_URL</td>
<td>Set an external mongodb URL to use for nosqlclient, <b>by
default an internal mongodb is being used</b></td>
</tr>
<tr>
<th scope="row">3</th>
<td>MONGO_OPLOG_URL</td>
<td>To track nosqlclient's mongo operations set an external mongodb
URL, <b>by
default there's no tracking</b></td>
</tr>
<tr>
<th scope="row">4</th>
<td>STARTUP_DELAY</td>
<td>Delay container's startup to let everything startup, <b>by
default there's no delay</b></td>
</tr>
<tr>
<th scope="row">5</th>
<td>MONGOCLIENT_AUTH</td>
<td>Enable basic authentication for Nosqlclient, <b>by
default it's set to false</b>
</td>
</tr>
<tr>
<th scope="row">6</th>
<td>MONGOCLIENT_USERNAME</td>
<td>Basic authentication's username, has to be set with <b>MONGOCLIENT_AUTH</b>,
<b>by
default there's no username</b>
</td>
</tr>
<tr>
<th scope="row">7</th>
<td>MONGOCLIENT_PASSWORD</td>
<td>Basic authentication's password, has to be set with <b>MONGOCLIENT_AUTH</b>
and <b>MONGOCLIENT_USERNAME</b>, <b>by
default there's no password</b>
</td>
</tr>
<tr>
<th scope="row">8</th>
<td>MONGOCLIENT_DEFAULT_CONNECTION_URL</td>
<td>You can specify a default connection url, that will be injected
into Nosqlclient at startup so that, you won't have to create
connection manually after installation.
</td>
</tr>
</tbody>
</table>
</div><!--//table-responsive-->
</div>
</div>
<div class="row">
<div class="col-md-12 col-sm-12 col-xs-12">
<h6>Available Tags</h6>
<p>Each released version is being tagged at docker hub to be used as stable
releases. But it's okay to use <code>latest</code> tag everytime.</p>
<ul class="list">
<li>latest</li>
<li>2.2.0</li>
<li>2.1.0</li>
<li>2.0.0</li>
<li>1.5.0</li>
<li>1.4.0 (deprecated)</li>
</ul>
</div>
</div>
<div class="code-block">
<h6>Example Docker Run Commands</h6>
<div class="table-responsive">
<table class="table">
<thead>
<tr>
<th>#</th>
<th>Example</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th scope="row">1</th>
<td><code>docker pull mongoclient/mongoclient</code></td>
<td>Runs master branch</td>
</tr>
<tr>
<th scope="row">2</th>
<td><code>docker pull mongoclient/mongoclient:2.2.0</code></td>
<td>Runs version 2.2.0</td>
</tr>
<tr>
<th scope="row">3</th>
<td><code>docker run -d -p 3000:3000 \<br/> -v <path>:/data/db \
<br/>mongoclient/mongoclient</code>
</td>
<td>Bind an extra volume to <b>/data/db</b> to keep your connections,
settings persistent
</td>
</tr>
<tr>
<th scope="row">4</th>
<td><code>docker run -d -p 3000:3000 \<br/>
-e ROOT_URL=http://example.com/nosqlclient \<br/>
mongoclient/mongoclient</code>
</td>
<td>
Set <b>ROOT_URL</b> environment variable to start Nosqlclient from
another base url
</td>
</tr>
</tbody>
</table>
</div>
</div><!--//code-block-->
</div><!--//section-block-->
<div id="compile" class="section-block">
<h3 class="block-title">Compile as Meteor Application (WEB)</h3>
<p>This is a hard way to start using Nosqlclient, but if you're already a <a
href="https://www.meteor.com/">MeteorJS</a> developer and want to try some
experimental stuff that you've implemented you can choose this way
</p>
<div class="row">
<div class="col-md-12 col-sm-12 col-xs-12">
<h6>TL;DR</h6>
<ol class="list">
<li>Install <a href="https://www.meteor.com/"> MeteorJS</a> (supports all
platforms)
</li>
<li>Download latest <a
href="https://github.com/nosqlclient/nosqlclient/archive/master.zip">
Nosqlclient source</a></li>
<li>Unzip source code and navigate into <b>nosqlclient-master</b></li>
<li>Execute <code>meteor npm install</code></li>
<li>Execute <code>meteor --port 3000</code></li>
<li>All set, now you can reach Nosqlclient from your browser <b>localhost:3000</b>
</li>
</ol>
</div>
</div><!--//row-->
<div class="row">
<div class="col-md-12 col-sm-12 col-xs-12">
<p>Nosqlclient uses MeteorJS version 1.5.1 as of version 2.2.0. To read
complete MeteorJS guide you can follow <a href="http://docs.meteor.com/">
this link</a>. To read more about code guideline, and how to contribute,
you can <a
href="user_manual.html">check here</a></p>
</div>
</div>
<div class="row">
<div class="col-md-12 col-sm-12 col-xs-12">
<h6>Available Environment Variables</h6>
<div class="table-responsive">
<table class="table">
<thead>
<tr>
<th>#</th>
<th>Environment Variable</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th scope="row">1</th>
<td>ROOT_URL</td>
<td>Useful to start nosqlclient from another base URL, <b>by default
uses root</b></td>
</tr>
<tr>
<th scope="row">2</th>
<td>MONGO_URL</td>
<td>Set an external mongodb URL to use for nosqlclient, <b>by
default an internal mongodb is being used by meteor itself</b>
</td>
</tr>
<tr>
<th scope="row">3</th>
<td>PORT</td>
<td>Change port of meteor, can be also set by <b>--port</b> argument
at startup <b>by
default it's set to 3000</b></td>
</tr>
<tr>
<th scope="row">4</th>
<td>MONGOCLIENT_AUTH</td>
<td>Enable basic authentication for Nosqlclient, <b>by
default it's set to false</b>
</td>
</tr>
<tr>
<th scope="row">5</th>
<td>MONGOCLIENT_USERNAME</td>
<td>Basic authentication's username, has to be set with <b>MONGOCLIENT_AUTH</b>,
<b>by
default there's no username</b>
</td>
</tr>
<tr>
<th scope="row">6</th>
<td>MONGOCLIENT_PASSWORD</td>
<td>Basic authentication's password, has to be set with <b>MONGOCLIENT_AUTH</b>
and <b>MONGOCLIENT_USERNAME</b>, <b>by
default there's no password</b>
</td>
</tr>
<tr>
<th scope="row">7</th>
<td>MONGOCLIENT_DEFAULT_CONNECTION_URL</td>
<td>You can specify a default connection url, that will be injected
into Nosqlclient at startup so that, you won't have to create
connection manually after installation.
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div><!--//row-->
</div><!--//section-block-->
</section><!--//doc-section-->
<section id="update-section" class="doc-section">
<h2 class="section-title">Updating Nosqlclient From Previous Version</h2>
<div class="section-block">
<p>
Nosqlclient checks newer versions each time you select a collection from left panel.
It's main cause is forcing people <b>to update the newest version all the time.</b>
</p>
<p>
Per deployment type, or distribution type Nosqlclient offers a solution to migrate
your old connections and settings into new version.
</p>
<p>In case of migrating from 1.x version to 2.x version you may want to use <a
href="user_manual.html#nosqlclient_data"
class="scrollto">Import/Export</a> feature, which will automatically
migrate your data to 2.x versions regardless of your system or deployment.</p>
<div class="row">
<div class="col-md-12 col-sm-12 col-xs-12">
<h6>Distribution / Deployment Type</h6>
<ol class="list">
<li><a class="scrollto" href="#update_windows">Windows Portable</a>
</li>
<li><a class="scrollto" href="#update_linux">Linux Portable</a>
</li>
<li><a class="scrollto" href="#update_osx">OSx Portable</a>
</li>
<li><a class="scrollto" href="#update_docker">Docker</a>
</li>
<li><a class="scrollto" href="#update_other">Other deployments, compile from
source</a>
</li>
<li><a target="_blank" href="user_manual.html#nosqlclient_data">Platform
independent way</a>
</li>
</ol>
</div>
</div>
<div class="row">
<div class="col-md-12 col-sm-12 col-xs-12">
<h6 id="update_windows">1. Update Windows Portable</h6>
<p>
Nosqlclient keeps it's <b>internal mongodb's data path in</b> <code>%appdata%/mongoclient/db</code>
folder across versions. Therefore you don't have to worry about version
update, you can simply download newer version from the <a
href="https://github.com/nosqlclient/nosqlclient/releases/latest"
target="_blank">github page</a> and double click to open Nosqlclient.
</p>
</div>
</div>
<div class="row">
<div class="col-md-12 col-sm-12 col-xs-12">
<h6 id="update_linux">2. Update Linux Portable</h6>
<p>
Nosqlclient keeps it's <b>internal mongodb's data path in</b> <code>%HOME%/var/local/mongoclient/db</code>
folder across versions. Therefore you don't have to worry about version
update, you can simply download newer version from the <a
href="https://github.com/nosqlclient/nosqlclient/releases/latest"
target="_blank">github page</a> and double click to open Nosqlclient.
</p>
</div>
</div>
<div class="row">
<div class="col-md-12 col-sm-12 col-xs-12">
<h6 id="update_osx">3. Update OSx Portable</h6>
<p>
Nosqlclient keeps it's <b>internal mongodb's data path in</b> <code>%HOME%/Library/Preferences/Mongoclient/db</code>
folder across versions. Therefore you don't have to worry about version
update, you can simply download newer version from the <a
href="https://github.com/nosqlclient/nosqlclient/releases/latest"
target="_blank">github page</a> and double click to open Nosqlclient.
</p>
</div>
</div>
<div class="row">
<div class="col-md-12 col-sm-12 col-xs-12">
<h6 id="update_docker">4. Update Docker</h6>
<p>
The easiest way to update Nosqlclient is using Docker, if you're binding
proper volume to Nosqlclient across its versions, everything should work
fine. <a href="#docker" class="scrollto">Check here</a> for more info.
</p>
</div>
</div>
<div class="row">
<div class="col-md-12 col-sm-12 col-xs-12">
<h6 id="update_other">5. Update Other Deployments/Compile From Source</h6>
<p>
If you're compiling Nosqlclient from its source or doing another deployment,
you may find the relative data in the <code>my-deployment/local/db</code>,
so copying data path would be enough to keep everything.
</p>
<p>Except from that, it's always recommended to use <b>MONGO_URL</b> environment
variable, therefore you'll lose nothing across version updates.</p>
</div>
</div>
</div><!--//section-block-->
</section>
<section id="deployments-section" class="doc-section">
<h2 class="section-title">Other Deployment Options</h2>
<div class="section-block">
<p>
If you're not familiar with Docker and don't want to struggle with compiling
Nosqlclient as
MeteorJS application you can consider using one of these deployment options, some of
them lets you to deploy Nosqlclient platform, as a service, (PaaS) and for the rest
you need to manually setup Nosqlclient
</p>
</div><!--//section-block-->
<div id="systemd" class="section-block">
<h3 class="block-title">Systemd (Linux)</h3>
<div class="row">
<div class="col-md-12 col-sm-12 col-xs-12">
<h6>TL;DR</h6>
<ol class="list">
<li>Clone Nosqlclient <code>
git clone https://github.com/nosqlclient/nosqlclient.git</code>
</li>
<li>Install <a href="https://www.meteor.com/install" target="_blank">MeteorJS</a>
</li>
<li>Navigate to systemd folder <code>cd /etc/systemd/system/</code>
</li>
<li>Create file <b>nosqlclient.service</b> with the content:<br/><br/>
<code>
[Unit]<br/>
Description=MongoDB management tool<br/>
After=network-online.target<br/>
[Service]<br/>
User=nosqlclient<br/>
Group=nosqlclient<br/>
WorkingDirectory=/path/to/clone/nosqlclient/<br/>
Environment=MONGOCLIENT_AUTH=true<br/>
Environment=MONGOCLIENT_USERNAME=MYUSERNAME<br/>
Environment=MONGOCLIENT_PASSWORD=MYPASSWORD<br/>
ExecStart=/usr/local/bin/meteor --port MYPORT<br/>
[Install]<br/>
WantedBy=multi-user.target
</code>
</li>
<li>Execute <code>systemctl enable nosqlclient.service</code></li>
</ol>
</div>
</div>
<div style="margin-top: 30px" class="row">
<div class="col-md-12 col-sm-12 col-xs-12">
<p><a href="https://en.wikipedia.org/wiki/Systemd" target="_blank">Systemd </a>is
an init system used in Linux. Check wikipedia for more information.</p>
</div>
</div>
<div class="row">
<div class="col-md-12 col-sm-12 col-xs-12">
<h6>Environment Variables</h6>
<div class="table-responsive">
<table class="table">
<thead>
<tr>
<th>#</th>
<th>Configuration</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th scope="row">1</th>
<td>ROOT_URL</td>
<td>Useful to start nosqlclient from another base
URL, <b>by
default
uses root if empty</b></td>
</tr>
<tr>
<th scope="row">2</th>
<td>MONGO_URL</td>
<td>Set an external mongodb URL to use for
nosqlclient, <b>by
default it uses an internal one that comes from Meteor</b>
</td>
</tr>
<tr>
<th scope="row">3</th>
<td>MONGOCLIENT_AUTH</td>
<td>Enable basic authentication for Nosqlclient, <b>by
default it's set to false</b>
</td>
</tr>
<tr>
<th scope="row">4</th>
<td>MONGOCLIENT_USERNAME</td>
<td>Basic authentication's username, has to be set
with <b>MONGOCLIENT_AUTH</b>,
<b>by
default there's no username</b>
</td>
</tr>
<tr>
<th scope="row">5</th>
<td>MONGOCLIENT_PASSWORD</td>
<td>Basic authentication's password, has to be set
with <b>MONGOCLIENT_AUTH</b>
and <b>MONGOCLIENT_USERNAME</b>, <b>by
default there's no password</b>
</td>
</tr>
<tr>
<th scope="row">6</th>
<td>MONGOCLIENT_DEFAULT_CONNECTION_URL</td>
<td>You can specify a default connection url, that
will be
injected
into Nosqlclient at startup so that, you won't
have to
create
connection manually after installation.
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
<div id="heroku" class="section-block">
<h3 class="block-title">Heroku</h3>
<div class="row">
<div class="col-md-12 col-sm-12 col-xs-12">
<h6>TL;DR</h6>
<a href="https://heroku.com/deploy?template=https://github.com/nosqlclient/nosqlclient">
<img src="https://www.herokucdn.com/deploy/button.svg" alt="Deploy">
</a>
</div>
</div>
<div style="margin-top: 30px" class="row">
<div class="col-md-12 col-sm-12 col-xs-12">
<p>Heroku is a cloud platform as a service (PaaS) and bypasses
infrastructure
stuff. Nosqlclient takes advantage of <code>heroku-16</code>
stack which comes with Ubuntu 16.04. Since Nosqlclient's shell and
schema
analyzer depends on <b>Mongo</b> executable 3.4 and the executable
depends
on GLIBC's 2.23 version, this stack suits Nosqlclient most.</p>
<p>There's only one configuration you have to do while deploying to
<b>Heroku</b></p>
<div class="row">
<div class="col-md-12 col-sm-12 col-xs-12">
<h6>Environment Variables</h6>
<div class="table-responsive">
<table class="table">
<thead>
<tr>
<th>#</th>
<th>Configuration</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th scope="row">1</th>
<td>ROOT_URL</td>
<td>This has to be set as <b>http://<heroku-app-name>.herokuapp.com/<optional-path></b>,
heroku-app-name must be same as your application
name
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
<div class="row">
<div class="col-md-12 col-sm-12 col-xs-12">
<h6>MongoDB Dependency</h6>
<p>As Nosqlclient needs a running mongodb instance to persist
your
connections and settings, it uses <a
href="https://elements.heroku.com/addons/mongolab">mLab
addon</a>'s free edition which is enough to keep these
details.
</p>
</div>
</div>
</div>
</div>
</div><!--//section-block-->
<div id="cloud-foundry" class="section-block">
<h3 class="block-title">Cloud Foundry</h3>
<div class="row">
<div class="col-md-12 col-sm-12 col-xs-12">
<h6>TL;DR</h6>
<ol class="list">
<li>Clone Nosqlclient <code>
git clone https://github.com/nosqlclient/nosqlclient.git</code>
</li>
<li>Navigate into it <code>cd nosqlclient</code>
</li>
<li>Execute <code>mv manifest.yml.sample manifest.yml</code>
</li>
<li>Change variables inside of manifest.yml as how you wish</li>
<li>Install <a
href="https://docs.cloudfoundry.org/cf-cli/install-go-cli.html">command
line tool</a></li>
<li>Execute <code>cf login -a api.ng.bluemix.net -u username -p
password
</code></li>
<li>Execute <code>cf push
</code></li>
</ol>
</div>
</div>
<div style="margin-top: 30px" class="row">
<div class="col-md-12 col-sm-12 col-xs-12">
<p>As a developer you can trail the instance of CloudFoundry, either
from <a
href="https://console.ng.bluemix.net/">IBM Bluemix</a>
or <a href="https://console.run.pivotal.io/">Pivotal</a>. Since
Nosqlclient
needs a MongoDB instance to persist your connections and settings,
you need
an external mongodb which can be acquired from <a
href="https://mlab.com/">Mlab</a>
for free.
</p>
<p></p>
<p>You can change a few environment variable from inside of <b>manifest.yml</b>
</p>
<div class="row">
<div class="col-md-12 col-sm-12 col-xs-12">
<h6>Environment Variables (manifest.yml)</h6>
<div class="table-responsive">
<table class="table">
<thead>
<tr>
<th>#</th>
<th>Configuration</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th scope="row">1</th>
<td>ROOT_URL</td>
<td>Useful to start nosqlclient from another base
URL, <b>by
default
uses root if empty</b></td>
</tr>
<tr>
<th scope="row">2</th>
<td>MONGO_URL</td>
<td>Set an external mongodb URL to use for
nosqlclient, <b>by
default it's empty and has to be set</b>
</td>
</tr>
<tr>
<th scope="row">3</th>
<td>MONGOCLIENT_AUTH</td>
<td>Enable basic authentication for Nosqlclient, <b>by
default it's set to false</b>
</td>
</tr>
<tr>
<th scope="row">4</th>
<td>MONGOCLIENT_USERNAME</td>
<td>Basic authentication's username, has to be set
with <b>MONGOCLIENT_AUTH</b>,
<b>by
default there's no username</b>
</td>
</tr>
<tr>
<th scope="row">5</th>
<td>MONGOCLIENT_PASSWORD</td>
<td>Basic authentication's password, has to be set
with <b>MONGOCLIENT_AUTH</b>
and <b>MONGOCLIENT_USERNAME</b>, <b>by
default there's no password</b>
</td>
</tr>
<tr>
<th scope="row">6</th>
<td>MONGOCLIENT_DEFAULT_CONNECTION_URL</td>
<td>You can specify a default connection url, that
will be
injected
into Nosqlclient at startup so that, you won't
have to
create
connection manually after installation.
</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
</div>
</div>
</div><!--//section-block-->
<div id="galaxy" class="section-block">
<h3 class="block-title">Meteor Galaxy</h3>
<div class="row">
<div class="col-md-12 col-sm-12 col-xs-12">
<h6>TL;DR</h6>
<ol class="list">
<li>Install <a href="https://www.meteor.com/"> MeteorJS</a>
(supports all
platforms)
</li>
<li>Clone Nosqlclient <code>
git clone https://github.com/nosqlclient/nosqlclient.git</code>
</li>
<li>Navigate into it <code>cd nosqlclient</code>
</li>
<li>Create a <b>settings.json</b> file with content:
<code>
{
"galaxy.meteor.com": {
"env": {
"MONGO_URL": "mongodb://..."
}
}
}
</code>
</li>
<li>
<a href="http://galaxy-guide.meteor.com/deploy-guide.html#galaxy-deploy">Follow
here </a>for last command and deploy
</li>
</ol>
</div>
</div>
<div style="margin-top: 30px" class="row">
<div class="col-md-12 col-sm-12 col-xs-12">
<p>Galaxy has slightly better prices comparing to other hosting services
and
it's best to keep a MeteorJS application since it's a MeteorJS
product.</p>
<p>You can use a few environment variables during deployment, <a
href="http://galaxy-guide.meteor.com/environment-variables.html">follow
here</a> to learn how to set them.</p>
<div class="row">
<div class="col-md-12 col-sm-12 col-xs-12">
<h6>Environment Variables (over galaxy)</h6>
<div class="table-responsive">
<table class="table">
<thead>
<tr>
<th>#</th>
<th>Configuration</th>
<th>Description</th>
</tr>
</thead>
<tbody>
<tr>
<th scope="row">1</th>
<td>ROOT_URL</td>
<td>If you want to change base url of Nosqlclient
you can
use this parameter.
</td>
</tr>
<tr>
<th scope="row">2</th>
<td>MONGO_URL</td>
<td>This has to be set to deploy galaxy, since
Nosqlclient
depends on a MongoDB instance to persist
connections and
settings
</td>
</tr>
<tr>
<th scope="row">3</th>
<td>MONGOCLIENT_AUTH</td>
<td>Enable basic authentication for Nosqlclient, <b>by
default it's set to false</b>
</td>
</tr>
<tr>
<th scope="row">4</th>
<td>MONGOCLIENT_USERNAME</td>
<td>Basic authentication's username, has to be set
with <b>MONGOCLIENT_AUTH</b>,
<b>by
default there's no username</b>
</td>
</tr>
<tr>
<th scope="row">5</th>
<td>MONGOCLIENT_PASSWORD</td>
<td>Basic authentication's password, has to be set
with <b>MONGOCLIENT_AUTH</b>
and <b>MONGOCLIENT_USERNAME</b>, <b>by
default there's no password</b>
</td>
</tr>
<tr>
<th scope="row">6</th>
<td>MONGOCLIENT_DEFAULT_CONNECTION_URL</td>
<td>You can specify a default connection url, that
will be
injected
into Nosqlclient at startup so that, you won't
have to
create