carta-controller 2.0.2 → 2.0.5

package/docs/_build/html/schema.html

@@ -7,7 +7,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>CARTA configuration schema &mdash; CARTA Controller 2.0 documentation</title>
+  <title>CARTA configuration schema &mdash; CARTA Controller 3.0.0-beta.1d documentation</title>
   
 
   
@@ -340,124 +340,148 @@
 </tr>
 <tr class="row-even"><td colspan="3"><p>127.0.0.1</p></td>
 </tr>
-<tr class="row-odd"><td rowspan="4"><ul class="simple">
+<tr class="row-odd"><td rowspan="3"><ul class="simple">
+<li><p>httpOnly</p></li>
+</ul>
+</td>
+<td colspan="4"><p>Allow HTTP-only connections. For testing or internal networks only</p></td>
+</tr>
+<tr class="row-even"><td><p>type</p></td>
+<td colspan="3"><p><em>boolean</em></p></td>
+</tr>
+<tr class="row-odd"><td><p>default</p></td>
+<td colspan="3"><p>False</p></td>
+</tr>
+<tr class="row-even"><td rowspan="4"><ul class="simple">
 <li><p>serverAddress</p></li>
 </ul>
 </td>
 <td colspan="4"><p>Public-facing server address</p></td>
 </tr>
-<tr class="row-even"><td><p>type</p></td>
+<tr class="row-odd"><td><p>type</p></td>
 <td colspan="3"><p><em>string</em></p></td>
 </tr>
-<tr class="row-odd"><td><p>pattern</p></td>
+<tr class="row-even"><td><p>pattern</p></td>
 <td colspan="3"><p>^https?://</p></td>
 </tr>
-<tr class="row-even"><td><p>format</p></td>
+<tr class="row-odd"><td><p>format</p></td>
 <td colspan="3"><p>uri</p></td>
 </tr>
-<tr class="row-odd"><td rowspan="4"><ul class="simple">
+<tr class="row-even"><td rowspan="4"><ul class="simple">
 <li><p>dashboardAddress</p></li>
 </ul>
 </td>
 <td colspan="4"><p>Optional parameter for explicitly configuring a custom dashboard address</p></td>
 </tr>
-<tr class="row-even"><td><p>type</p></td>
+<tr class="row-odd"><td><p>type</p></td>
 <td colspan="3"><p><em>string</em></p></td>
 </tr>
-<tr class="row-odd"><td><p>pattern</p></td>
+<tr class="row-even"><td><p>pattern</p></td>
 <td colspan="3"><p>^https?://</p></td>
 </tr>
-<tr class="row-even"><td><p>format</p></td>
+<tr class="row-odd"><td><p>format</p></td>
 <td colspan="3"><p>uri</p></td>
 </tr>
-<tr class="row-odd"><td rowspan="4"><ul class="simple">
+<tr class="row-even"><td rowspan="4"><ul class="simple">
 <li><p>apiAddress</p></li>
 </ul>
 </td>
 <td colspan="4"><p>Optional parameter for explicitly configuring a custom API base address</p></td>
 </tr>
-<tr class="row-even"><td><p>type</p></td>
+<tr class="row-odd"><td><p>type</p></td>
 <td colspan="3"><p><em>string</em></p></td>
 </tr>
-<tr class="row-odd"><td><p>pattern</p></td>
+<tr class="row-even"><td><p>pattern</p></td>
 <td colspan="3"><p>^https?://</p></td>
 </tr>
-<tr class="row-even"><td><p>format</p></td>
+<tr class="row-odd"><td><p>format</p></td>
 <td colspan="3"><p>uri</p></td>
 </tr>
-<tr class="row-odd"><td rowspan="2"><ul class="simple">
+<tr class="row-even"><td rowspan="2"><ul class="simple">
 <li><p>frontendPath</p></li>
 </ul>
 </td>
 <td colspan="4"><p>Path to the built frontend folder. If no path is provided, the packaged version will be used</p></td>
 </tr>
-<tr class="row-even"><td><p>type</p></td>
+<tr class="row-odd"><td><p>type</p></td>
 <td colspan="3"><p><em>string</em></p></td>
 </tr>
-<tr class="row-odd"><td rowspan="12"><ul class="simple">
+<tr class="row-even"><td rowspan="12"><ul class="simple">
 <li><p>backendPorts</p></li>
 </ul>
 </td>
 <td colspan="4"><p>Port range to use for the CARTA backend process</p></td>
 </tr>
-<tr class="row-even"><td><p>type</p></td>
+<tr class="row-odd"><td><p>type</p></td>
 <td colspan="3"><p><em>object</em></p></td>
 </tr>
-<tr class="row-odd"><td rowspan="2"><p>default</p></td>
+<tr class="row-even"><td rowspan="2"><p>default</p></td>
 <td><p>min</p></td>
 <td colspan="2"><p>3003</p></td>
 </tr>
-<tr class="row-even"><td><p>max</p></td>
+<tr class="row-odd"><td><p>max</p></td>
 <td colspan="2"><p>3500</p></td>
 </tr>
-<tr class="row-odd"><td colspan="4"><p>properties</p></td>
+<tr class="row-even"><td colspan="4"><p>properties</p></td>
 </tr>
-<tr class="row-even"><td rowspan="3"><ul class="simple">
+<tr class="row-odd"><td rowspan="3"><ul class="simple">
 <li><p><strong>min</strong></p></li>
 </ul>
 </td>
 <td><p>type</p></td>
 <td colspan="2"><p><em>integer</em></p></td>
 </tr>
-<tr class="row-odd"><td><p>maximum</p></td>
+<tr class="row-even"><td><p>maximum</p></td>
 <td colspan="2"><p>65535</p></td>
 </tr>
-<tr class="row-even"><td><p>minimum</p></td>
+<tr class="row-odd"><td><p>minimum</p></td>
 <td colspan="2"><p>1024</p></td>
 </tr>
-<tr class="row-odd"><td rowspan="3"><ul class="simple">
+<tr class="row-even"><td rowspan="3"><ul class="simple">
 <li><p><strong>max</strong></p></li>
 </ul>
 </td>
 <td><p>type</p></td>
 <td colspan="2"><p><em>integer</em></p></td>
 </tr>
-<tr class="row-even"><td><p>maximum</p></td>
+<tr class="row-odd"><td><p>maximum</p></td>
 <td colspan="2"><p>65535</p></td>
 </tr>
-<tr class="row-odd"><td><p>minimum</p></td>
+<tr class="row-even"><td><p>minimum</p></td>
 <td colspan="2"><p>1024</p></td>
 </tr>
-<tr class="row-even"><td><p>additionalProperties</p></td>
+<tr class="row-odd"><td><p>additionalProperties</p></td>
 <td colspan="3"><p>False</p></td>
 </tr>
-<tr class="row-odd"><td rowspan="5"><ul class="simple">
+<tr class="row-even"><td rowspan="5"><ul class="simple">
 <li><p>processCommand</p></li>
 </ul>
 </td>
 <td colspan="4"><p>Path to CARTA backend executable</p></td>
 </tr>
-<tr class="row-even"><td><p>type</p></td>
+<tr class="row-odd"><td><p>type</p></td>
 <td colspan="3"><p><em>string</em></p></td>
 </tr>
-<tr class="row-odd"><td rowspan="2"><p>examples</p></td>
+<tr class="row-even"><td rowspan="2"><p>examples</p></td>
 <td colspan="3"><p>/usr/bin/carta_backend</p></td>
 </tr>
-<tr class="row-even"><td colspan="3"><p>/usr/local/bin/carta_backend</p></td>
+<tr class="row-odd"><td colspan="3"><p>/usr/local/bin/carta_backend</p></td>
 </tr>
-<tr class="row-odd"><td><p>default</p></td>
+<tr class="row-even"><td><p>default</p></td>
 <td colspan="3"><p>/usr/bin/carta_backend</p></td>
 </tr>
+<tr class="row-odd"><td rowspan="3"><ul class="simple">
+<li><p>preserveEnv</p></li>
+</ul>
+</td>
+<td colspan="4"><p>Use the –preserve-env argument when calling sudo</p></td>
+</tr>
+<tr class="row-even"><td><p>type</p></td>
+<td colspan="3"><p><em>boolean</em></p></td>
+</tr>
+<tr class="row-odd"><td><p>default</p></td>
+<td colspan="3"><p>True</p></td>
+</tr>
 <tr class="row-even"><td rowspan="4"><ul class="simple">
 <li><p>killCommand</p></li>
 </ul>
@@ -991,7 +1015,7 @@
 <tr class="row-odd"><td><p>default</p></td>
 <td colspan="2"><p>15m</p></td>
 </tr>
-<tr class="row-even"><td rowspan="19"><ul class="simple">
+<tr class="row-even"><td rowspan="38"><ul class="simple">
 <li><p><strong>ldapOptions</strong></p></li>
 </ul>
 </td>
@@ -1062,10 +1086,88 @@
 <tr class="row-odd"><td><p>default</p></td>
 <td><p>True</p></td>
 </tr>
-<tr class="row-even"><td><p>additionalProperties</p></td>
-<td colspan="2"><p>False</p></td>
+<tr class="row-even"><td rowspan="3"><ul class="simple">
+<li><p>bindProperty</p></li>
+</ul>
+</td>
+<td colspan="2"><p>Property of the LDAP user object to use when binding to verify the password</p></td>
+</tr>
+<tr class="row-odd"><td><p>type</p></td>
+<td><p><em>string</em></p></td>
+</tr>
+<tr class="row-even"><td><p>default</p></td>
+<td><p>dn</p></td>
+</tr>
+<tr class="row-odd"><td rowspan="4"><ul class="simple">
+<li><p>searchScope</p></li>
+</ul>
+</td>
+<td colspan="2"><p>Scope of the search</p></td>
+</tr>
+<tr class="row-even"><td><p>type</p></td>
+<td><p><em>string</em></p></td>
+</tr>
+<tr class="row-odd"><td><p>enum</p></td>
+<td><p>base, one, sub</p></td>
+</tr>
+<tr class="row-even"><td><p>default</p></td>
+<td><p>sub</p></td>
+</tr>
+<tr class="row-odd"><td rowspan="2"><ul class="simple">
+<li><p>bindDN</p></li>
+</ul>
+</td>
+<td colspan="2"><p>Admin connection DN, e.g. uid=myapp,ou=users,dc=example,dc=org. If not given at all, admin client is not bound.</p></td>
+</tr>
+<tr class="row-even"><td><p>type</p></td>
+<td><p><em>string</em></p></td>
+</tr>
+<tr class="row-odd"><td rowspan="2"><ul class="simple">
+<li><p>bindCredentials</p></li>
+</ul>
+</td>
+<td colspan="2"><p>Password for bindDN</p></td>
+</tr>
+<tr class="row-even"><td><p>type</p></td>
+<td><p><em>string</em></p></td>
+</tr>
+<tr class="row-odd"><td rowspan="3"><ul class="simple">
+<li><p>cache</p></li>
+</ul>
+</td>
+<td colspan="2"><p>If true, then up to 100 credentials at a time will be cached for 5 minutes</p></td>
+</tr>
+<tr class="row-even"><td><p>type</p></td>
+<td><p><em>boolean</em></p></td>
+</tr>
+<tr class="row-odd"><td><p>default</p></td>
+<td><p>False</p></td>
+</tr>
+<tr class="row-even"><td rowspan="3"><ul class="simple">
+<li><p>strictDN</p></li>
+</ul>
+</td>
+<td colspan="2"><p>Force strict DN parsing for client methods</p></td>
+</tr>
+<tr class="row-odd"><td><p>type</p></td>
+<td><p><em>boolean</em></p></td>
+</tr>
+<tr class="row-even"><td><p>default</p></td>
+<td><p>True</p></td>
+</tr>
+<tr class="row-odd"><td rowspan="2"><ul class="simple">
+<li><p>idleTimeout</p></li>
+</ul>
+</td>
+<td colspan="2"><p>Milliseconds after last activity before client emits idle event</p></td>
+</tr>
+<tr class="row-even"><td><p>type</p></td>
+<td><p><em>number</em></p></td>
 </tr>
 <tr class="row-odd"><td><p>additionalProperties</p></td>
+<td colspan="2"><p>True</p></td>
+</tr>
+<tr class="row-even"><td><p>additionalProperties</p></td>
 <td colspan="3"><p>False</p></td>
 </tr>
 </tbody>

package/docs/_build/html/search.html

@@ -7,7 +7,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>Search &mdash; CARTA Controller 2.0 documentation</title>
+  <title>Search &mdash; CARTA Controller 3.0.0-beta.1d documentation</title>
   
 
   

package/docs/_build/html/searchindex.js

@@ -1 +1 @@
-Search.setIndex({docnames:["configuration","index","installation","introduction","schema","ubuntu_focal_instructions"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["configuration.rst","index.rst","installation.rst","introduction.rst","schema.rst","ubuntu_focal_instructions.rst"],objects:{},objnames:{},objtypes:{},terms:{"15h":4,"15m":4,"606f7e":4,"90s":4,"boolean":4,"default":[0,3,4],"enum":4,"final":5,"long":3,"new":3,"null":4,"public":[0,4,5],"return":[0,3],"short":3,"static":3,"switch":5,"true":4,"var":[0,4,5],For:0,LTS:[3,5],TLS:4,The:[0,2,3,4,5],These:5,Use:3,abl:0,abov:3,accept:4,access:[0,3,4,5],accesstokenag:4,account:0,adapt:5,add:[0,5],added:[],adding:2,addit:[0,4,5],additionalarg:[0,4],additionalproperti:4,addon:5,address:4,addus:5,adher:0,adjust:[0,3],advis:4,after:[2,3,4,5],algorithm:4,all:[0,2,3,4,5],allow:[0,3,5],almost:5,also:[0,2,3],alter:0,amount:3,analysi:1,ani:[0,4],apach:0,api:[3,4],apiaddress:4,app:4,appear:[0,4,5],applic:[3,4],appropri:3,apt:[2,5],argument:[0,4],arrai:4,assist:3,assum:[0,3,5],astronomi:1,attempt:0,auth:[3,4],authent:[1,4,5],author:3,authprovid:[0,1],automat:[0,2,4,5],backend:[1,3,4],backendport:4,background:[0,4],backgroundcolor:[0,4],badger:5,banner:[0,4],bannercolor:[0,4],bannerimag:[0,4],base:[3,4],basefoldertempl:[0,4],bash:[0,5],bashrc:[],beaver:2,becaus:0,been:3,befor:4,behind:[3,4],belong:[0,5],below:5,beta:[2,3,5],better:3,bin:[0,4,5],binari:2,bionic:[2,5],both:[0,2],branch:[],build:[2,3,5],built:[0,4],call:5,can:[0,2,3,5],carta:[2,3],carta_backend:[0,4,5],carta_config:4,carta_control:[0,5],carta_kill_script:[],carta_priv:[0,4,5],carta_publ:[0,4,5],cartavi:5,casacor:2,cert:0,chang:0,check:4,child:0,child_pid:0,chown:5,click:4,client:[3,4],clientid:4,clone:2,code:3,color:4,com:[0,4,5],comm:0,command:[0,5],command_of_pid:0,command_to_match:0,comment:[0,4],commun:0,compat:[2,4],compil:[3,5],compon:1,config:[0,5],config_schema:0,configur:[1,2,3],confluenc:[],connect:[0,3,4],consol:3,contact:[0,3,4],contain:3,content:1,control:[3,4],cooki:3,copi:[],core:2,correct:0,correctli:[],correspond:2,creat:[2,3],credenti:0,cube:1,curl:5,current:5,custom:[2,4],customis:[0,5],d2dce5:0,dashboard:[0,3,4,5],dashboardaddress:4,dat:4,data:[0,2,4],databas:[0,4],databasenam:[0,4],datatim:4,datetim:4,deb:5,debian:2,defin:4,deleg:3,deni:0,depend:[1,2],deploy:[3,4],describ:[1,3],detail:[1,2,4,5],dev:[2,5],develop:[2,5],differ:[2,5],direct:0,directli:3,directori:4,disabl:[],displai:4,document:[1,3,4,5],doe:0,domain:[0,4],dure:3,dynam:3,echo:0,edit:[0,2,5],either:3,els:0,email:[0,4],empti:4,encount:3,ensur:[0,5],enter:[0,4],environ:0,equival:0,error:3,es256:4,es384:4,es512:4,especi:0,essenti:5,etc:[0,4,5],exampl:[0,4,5],exchang:3,execut:[0,3,4,5],exist:0,exit:0,exit_aft:[],exit_timeout:4,explicitli:4,extern:[0,1,3],f6f8fa:[0,4],face:4,fair:3,fals:4,featur:3,feedback:3,ff11ee:4,field:[0,4],file:[0,2,4,5],filter:4,fit:0,flag:[0,5],flexibl:3,flow:3,focal:[1,2],folder:4,footer:4,footertext:[0,4],forev:2,format:[0,3,4],forward:[0,5],fossa:[1,2],four:3,from:[0,2,5],frontend:[1,3,4,5],frontendpath:4,fssl:5,futur:1,geco:[],gener:[0,5],genrsa:[0,5],get:[0,1,2,5],github:2,githubusercont:[],give:3,given:[0,4],gmail:4,googl:[1,3],googleusercont:4,group:[0,5],h_mm_ss:4,handl:[0,3],has:[0,3],have:[0,2,4,5],hello:[],help:1,helpdesk:[3,4],here:5,home:[0,4,5],host:[0,2,3,4],href:[0,4],hs256:4,hs384:4,hs512:4,html:4,http:[0,3,4,5],http_upgrad:0,httponli:3,identifi:[4,5],idia:[],imag:0,implement:3,includ:5,incom:0,inform:[0,4],infotext:[0,4],init_exit_aft:[],initial_timeout:4,instal:[1,3],instanc:4,institut:[0,4],instruct:[0,1,2],integ:4,interfac:[3,4],intern:0,introduct:1,issu:3,issuer:[0,4],item:4,itself:3,javascript:0,json:[0,5],jsonc:0,just:2,jwt:[3,4],keep:2,kei:[0,3,4,5],kern:2,keyalgorithm:1,kill:[0,4,5],killcommand:[0,4],latest:[2,5],layout:3,ldap:[0,1,3],ldapopt:4,least:[],level:[0,4],lib:5,librari:3,lifetim:4,like:[2,4],line:0,list:4,listen:[0,4],live:3,local:[0,1,5],localhost:[0,4],locat:[0,4],log:[0,4,5],logfiletempl:[0,4],login:0,logintext:[0,4],logo:4,logoutaddress:4,lookup:[0,4],lts:[],mai:[0,2],mailto:[0,4],make:[0,4,5],manag:[2,3],map:0,match:0,max:4,maximum:4,method:0,metric:3,min:4,minimum:4,minitem:4,minlength:4,mkdir:5,mode:3,modif:0,modul:0,mongodb:[0,3,4,5],more:[2,3,4],most:[],multipl:0,must:[0,3,4],my_auth_server_public_kei:4,name:[0,4],nativ:5,need:[0,3,4],no_http:0,no_log:0,node:[3,5],node_modul:[],nodej:[3,5],nodesourc:5,non:3,nopasswd:0,note:5,notic:0,npm:[2,3,5],number:3,nvm:[],nvm_bin:[],oauth2:[3,4],object:4,occur:5,omit:4,omp_thread:4,onli:[0,4,5],openssl:[0,5],option:[0,2,4,5],order:0,other:[0,4],our:2,out:[0,4,5],outform:[0,5],over:0,overrid:0,own:5,packag:[2,4],pair:0,pam:[0,3,4,5],paramet:4,part:5,pass:[3,4,5],password:[0,3,4],passwordless:5,path:[0,4],pattern:4,pem:[0,4,5],perm:5,permit:0,pgrep:0,pid:[0,4],place:3,placehold:4,plain:4,pleas:[0,2,3,4,5],pm2:2,png:4,point:[0,3],port:[0,3,4,5],posit:0,possibl:[0,2],ppa:[2,5],prefer:3,privat:[0,3,4,5],privatekeyloc:[0,4],privileg:0,problem:[0,3,4],process:[0,1,3,4,5],processcommand:[0,4],profil:[],properti:4,provid:[0,1,2,3,4,5],proxi:[0,3,4],proxy_cache_bypass:0,proxy_http_vers:0,proxy_pass:0,proxy_set_head:0,ps256:4,ps384:4,ps512:4,publickeyloc:[0,4],pubout:[0,5],rang:4,raw:[],read:0,reason:[],reboot:[2,5],recommend:2,reconnect:4,red:4,redirect:[0,3],refer:[2,4,5],refresh:[0,3,4],refreshtokenag:4,releas:2,relev:5,reload:0,remot:0,remote_addr:0,render:1,replac:4,repo:[3,5],repositori:[2,5],request:0,request_uri:0,requir:[0,2,3],respect:[0,4],respons:4,restrict:0,rgb:4,root:[],rootfoldertempl:[0,4],rout:4,rs256:4,rs384:4,rs512:4,rsa:[0,5],run:[0,1,3,4],safe:0,same:0,sampl:5,save:5,schema:[0,1],script:[0,2,4],search:4,searchbas:4,searchfilt:4,section:5,secur:[],see:4,send:4,serv:[0,3],server:[0,3,4,5],server_nam:0,serveraddress:[0,4],serverinterfac:[0,4],serverport:[0,4],servic:5,session:3,set:0,setenv:0,setup_lt:5,shadow:[0,5],shell:5,should:[2,3,4,5],sign:[0,3,4],simpl:3,some:3,sourc:2,span:[0,4],specif:0,specifi:[0,4],ssl:[0,4],ssl_certif:0,ssl_certificate_kei:0,standard:[0,3],start:[0,2,4,5],startdelai:4,starttl:4,startup:2,step:1,still:[3,4],stop:0,store:3,string:4,strongli:0,stub:4,style:0,sub:4,subfold:4,submit:3,sudo:[0,5],sudoer:[0,5],suggest:[0,4],support:[1,5],suppress:0,svg:[0,4],system:[1,2,3,4,5],tabl:[0,4],tag:3,team:5,test:[0,3,4],text:4,than:4,thei:[0,5],them:[3,5],thi:[0,1,3,4,5],thread:[],three:[],through:4,time:4,token:[0,3,4],tokenrefreshaddress:4,tool:[1,5],top:[0,4],top_level_fold:0,traffic:0,translat:0,trust:0,txt:4,type:4,ubuntu:[1,2],uid:4,unauthor:0,unchang:5,undefin:4,under:0,uniqu:[0,4],uniquefield:4,unix:[0,5],unnecessari:[],unsaf:5,updat:[0,5],upgrad:0,uri:[0,4],url:4,use:[0,2,3,4],used:[0,3,4,5],useemailasid:4,user1:0,user1_alt:0,user2:0,user:[0,3,4,5],user_id:4,userlookup:4,userlookupt:4,usermod:5,usernam:[0,3,4],usert:4,using:[0,2,4,5],usr:[0,4,5],util:2,v12:5,v14:5,v16:5,valid:[0,3,4],validdomain:4,verifi:4,version:[2,3,4,5],via:[0,3,4],visudo:[0,5],wai:0,wait:4,want:3,watch:0,web:3,websocket:0,welcom:[0,4],well:3,what:0,when:[0,2,4],whenev:0,where:5,whether:4,which:[0,2,3],who:5,wish:2,without:[0,2],work:1,world:[],would:[2,4],write:0,you:[0,2,3,4,5],your:[0,2,4,5],yyyymmdd:4},titles:["Configuration","CARTA Controller","Installation","Introduction","CARTA configuration schema","Step-by-step instructions for Ubuntu 20.04.2 (Focal Fossa)"],titleterms:{authent:[0,3],authprovid:4,backend:[0,2,5],carta:[0,1,4,5],configur:[0,4,5],control:[0,1,2,5],creat:5,depend:[3,5],directori:[0,5],extern:4,focal:5,fossa:5,frontend:2,futur:3,gener:[],get:3,googl:4,help:3,instal:[2,5],instruct:5,introduct:3,kei:[],keyalgorithm:4,ldap:4,local:4,nginx:[0,5],other:5,packag:5,permiss:[0,5],pm2:5,requir:5,run:[2,5],schema:4,script:5,set:5,startup:5,step:5,support:3,system:0,ubuntu:5,work:3}})
+Search.setIndex({docnames:["configuration","index","installation","introduction","schema","ubuntu_focal_instructions"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["configuration.rst","index.rst","installation.rst","introduction.rst","schema.rst","ubuntu_focal_instructions.rst"],objects:{},objnames:{},objtypes:{},terms:{"15h":4,"15m":4,"606f7e":4,"90s":4,"boolean":4,"default":[0,3,4],"enum":4,"final":5,"long":3,"new":3,"null":4,"public":[0,4,5],"return":[0,3],"short":3,"static":3,"switch":5,"true":4,"var":[0,4,5],For:[0,4],LTS:[3,5],TLS:4,The:[0,2,3,4,5],These:5,Use:[3,4],_config_control:[],_config_controller_:[],abl:0,abov:3,accept:4,access:[0,3,4,5],accesstokenag:4,account:0,across:[],activ:4,adapt:5,add:[0,5],added:[],adding:2,addit:[0,4,5],additionalarg:[0,4],additionalproperti:4,addon:5,address:4,addus:5,adher:0,adjust:[0,3],admin:4,advis:4,after:[2,3,4,5],algorithm:4,all:[0,2,3,4,5],allow:[0,3,4,5],almost:5,also:[0,2,3],alter:0,amount:3,analysi:1,ani:[0,4],apach:0,api:[3,4],apiaddress:4,app:4,appear:[0,4,5],applic:[3,4],appropri:3,apt:[2,5],argument:[0,4],arrai:4,assist:3,assum:[0,3,5],astronomi:1,attempt:0,auth:[3,4],authent:[1,4,5],author:3,authprovid:[0,1],automat:[0,2,4,5],backend:[1,3,4],backendport:4,background:[0,4],backgroundcolor:[0,4],badger:5,banner:[0,4],bannercolor:[0,4],bannerimag:[0,4],base:[3,4],basefoldertempl:[0,4],bash:[0,5],bashrc:[],beaver:2,becaus:0,been:3,befor:4,behind:[3,4],belong:[0,5],below:5,beta:[2,3,5],better:3,bin:[0,4,5],binari:2,bind:4,bindcredenti:4,binddn:4,bindproperti:4,bionic:[2,5],both:[0,2],bound:4,branch:[],build:[2,3,5],built:[0,4],cach:4,call:[4,5],can:[0,2,3,5],carta:[2,3],carta_auth_token:0,carta_backend:[0,4,5],carta_config:4,carta_control:[0,5],carta_kill_script:[],carta_priv:[0,4,5],carta_publ:[0,4,5],cartavi:5,casacor:2,cert:0,chang:0,check:4,child:0,child_pid:0,chown:5,click:4,client:[3,4],clientid:4,clone:2,code:3,color:4,com:[0,4,5],comm:0,command:[0,5],command_of_pid:0,command_to_match:0,comment:[0,4],commun:0,compat:[2,4],compil:[3,5],compon:1,config:[0,5],config_controller_:[],config_schema:0,configur:[1,2,3],confluenc:[],connect:[0,3,4],consol:3,contact:[0,3,4],contain:3,content:1,control:[3,4],cooki:3,copi:[],core:2,correct:0,correctli:[],correspond:2,creat:[2,3],credenti:[0,4],cube:1,curl:5,current:5,custom:[2,4],customis:[0,5],d2dce5:0,dashboard:[0,3,4,5],dashboardaddress:4,dat:4,data:[0,2,4],databas:[0,4],databasenam:[0,4],datatim:4,datetim:4,deb:5,debian:2,defin:4,deleg:3,deni:0,depend:[1,2],deploy:[3,4],describ:[1,3],detail:[1,2,4,5],dev:[2,5],develop:[2,5],differ:[2,5],direct:0,directli:3,directori:4,disabl:[],displai:4,document:[1,3,4,5],doe:0,domain:[0,4],dure:3,dynam:3,echo:0,edit:[0,2,5],either:3,els:0,email:[0,4],emit:4,empti:4,encount:3,ensur:[0,5],enter:[0,4],env:[0,4],env_keep:0,environ:0,environment:[],equival:0,error:3,es256:4,es384:4,es512:4,especi:0,essenti:5,etc:[0,4,5],event:4,exampl:[0,4,5],exchang:3,execut:[0,3,4,5],exist:0,exit:0,exit_aft:[],exit_timeout:4,explicitli:4,extern:[0,1,3],f6f8fa:[0,4],face:4,fair:3,fals:[0,4],featur:3,feedback:3,ff11ee:4,field:[0,4],file:[0,2,4,5],filter:4,fit:0,flag:[0,5],flexibl:3,flow:3,focal:[1,2],folder:4,footer:4,footertext:[0,4],forc:4,forev:2,format:[0,3,4],forward:[0,5],fossa:[1,2],four:3,from:[0,2,5],frontend:[1,3,4,5],frontendpath:4,fssl:5,futur:1,geco:[],gener:[0,5],genrsa:[0,5],get:[0,1,2,5],github:2,githubusercont:[],give:3,given:[0,4],gmail:4,googl:[1,3],googleusercont:4,group:[0,5],h_mm_ss:4,handl:[0,3],has:[0,3],have:[0,2,4,5],hello:[],help:1,helpdesk:[3,4],here:5,home:[0,4,5],host:[0,2,3,4],href:[0,4],hs256:4,hs384:4,hs512:4,html:4,http:[0,3,4,5],http_upgrad:0,httponli:[3,4],identifi:[4,5],idia:[],idl:4,idletimeout:4,imag:0,implement:3,includ:5,incom:0,inform:[0,4],infotext:[0,4],init_exit_aft:[],initial_timeout:4,instal:[1,3],instanc:4,institut:[0,4],instruct:[0,1,2],integ:4,interfac:[3,4],intern:[0,4],introduct:1,issu:3,issuer:[0,4],item:4,itself:3,javascript:0,json:[0,5],jsonc:0,just:2,jwt:[3,4],keep:2,kei:[0,3,4,5],kern:2,keyalgorithm:1,kill:[0,4,5],killcommand:[0,4],last:4,latest:[2,5],layout:3,ldap:[0,1,3],ldapopt:4,least:[],level:[0,4],lib:5,librari:3,lifetim:4,like:[2,4],line:0,list:4,listen:[0,4],live:3,local:[0,1,5],localhost:[0,4],locat:[0,4],log:[0,4,5],logfiletempl:[0,4],login:0,logintext:[0,4],logo:4,logoutaddress:4,lookup:[0,4],lts:[],mai:[0,2],mailto:[0,4],make:[0,4,5],manag:[2,3],map:0,match:0,max:4,maximum:4,method:[0,4],metric:3,millisecond:4,min:4,minimum:4,minitem:4,minlength:4,minut:4,mkdir:5,mode:3,modif:0,modul:0,mongodb:[0,3,4,5],more:[2,3,4],most:[],multipl:0,must:[0,3,4],my_auth_server_public_kei:4,myapp:4,name:[0,4],nativ:5,need:[0,3,4],network:4,no_http:0,no_log:0,node:[3,5],node_modul:[],nodej:[3,5],nodesourc:5,non:3,nopasswd:0,note:5,notic:0,npm:[2,3,5],number:[3,4],nvm:[],nvm_bin:[],oauth2:[3,4],object:4,occur:5,old:0,older:0,omit:4,omp_thread:4,one:4,onli:[0,4,5],openssl:[0,5],option:[0,2,4,5],order:0,org:4,other:[0,4],our:2,out:[0,4,5],outform:[0,5],over:0,overrid:0,own:5,packag:[2,4],pair:0,pam:[0,3,4,5],paramet:4,pars:4,part:5,pass:[3,4,5],password:[0,3,4],passwordless:5,path:[0,4],pattern:4,pem:[0,4,5],perm:5,permit:0,persist:[],pgrep:0,pid:[0,4],place:3,placehold:4,plain:4,pleas:[0,2,3,4,5],pm2:2,png:4,point:[0,3],port:[0,3,4,5],posit:0,possibl:[0,2],ppa:[2,5],prefer:3,preserv:[0,4],preserveenv:[0,4],privat:[0,3,4,5],privatekeyloc:[0,4],privileg:0,problem:[0,3,4],process:[0,1,3,4,5],processcommand:[0,4],profil:[],properti:4,provid:[0,1,2,3,4,5],proxi:[0,3,4],proxy_cache_bypass:0,proxy_http_vers:0,proxy_pass:0,proxy_set_head:0,ps256:4,ps384:4,ps512:4,publickeyloc:[0,4],pubout:[0,5],rang:4,raw:[],read:0,reason:[],reboot:[2,5],recommend:2,reconnect:4,red:4,redirect:[0,3],ref:[],refer:[2,4,5],refresh:[0,3,4],refreshtokenag:4,releas:2,relev:5,reload:0,remot:0,remote_addr:0,render:1,replac:4,repo:[3,5],repositori:[2,5],request:0,request_uri:0,requir:[0,2,3],respect:[0,4],respons:4,restrict:0,rgb:4,root:[],rootfoldertempl:[0,4],rout:4,rs256:4,rs384:4,rs512:4,rsa:[0,5],run:[0,1,3,4],safe:0,same:0,sampl:5,save:5,schema:[0,1],scope:4,script:[0,2,4],search:4,searchbas:4,searchfilt:4,searchscop:4,section:5,secur:[],see:4,send:4,serv:[0,3],server:[0,3,4,5],server_nam:0,serveraddress:[0,4],serverinterfac:[0,4],serverport:[0,4],servic:5,session:3,set:0,setenv:0,setup_lt:5,shadow:[0,5],shell:5,should:[2,3,4,5],sign:[0,3,4],simpl:3,some:3,sourc:2,span:[0,4],specif:0,specifi:[0,4],ssl:[0,4],ssl_certif:0,ssl_certificate_kei:0,standard:[0,3],start:[0,2,4,5],startdelai:4,starttl:4,startup:2,step:1,still:[3,4],stop:0,store:3,strict:4,strictdn:4,string:4,strongli:0,stub:4,style:0,sub:4,subfold:4,submit:3,sudo:[0,4,5],sudoer:[0,5],suggest:[0,4],support:[0,1,5],suppress:0,svg:[0,4],system:[1,2,3,4,5],tabl:[0,4],tag:3,team:5,test:[0,3,4],text:4,than:4,thei:[0,5],them:[3,5],thi:[0,1,3,4,5],thread:[],three:[],through:4,time:4,token:[0,3,4],tokenrefreshaddress:4,too:0,tool:[1,5],top:[0,4],top_level_fold:0,traffic:0,translat:0,trust:0,txt:4,type:4,ubuntu:[1,2],uid:4,unauthor:0,unchang:5,undefin:4,under:0,uniqu:[0,4],uniquefield:4,unix:[0,5],unnecessari:[],unsaf:5,updat:[0,5],upgrad:0,uri:[0,4],url:4,use:[0,2,3,4],used:[0,3,4,5],useemailasid:4,user1:0,user1_alt:0,user2:0,user:[0,3,4,5],user_id:4,userlookup:4,userlookupt:4,usermod:5,usernam:[0,3,4],usert:4,using:[0,2,4,5],usr:[0,4,5],util:2,v12:5,v14:5,v16:5,valid:[0,3,4],validdomain:4,variabl:0,verifi:4,version:[0,2,3,4,5],via:[0,3,4],visudo:[0,5],wai:0,wait:4,want:3,watch:0,web:3,websocket:0,welcom:[0,4],well:3,what:0,when:[0,2,4],whenev:0,where:5,whether:4,which:[0,2,3],who:5,wish:2,without:[0,2],work:1,world:[],would:[2,4],write:0,you:[0,2,3,4,5],your:[0,2,4,5],yyyymmdd:4},titles:["Configuration","CARTA Controller","Installation","Introduction","CARTA configuration schema","Step-by-step instructions for Ubuntu 20.04.2 (Focal Fossa)"],titleterms:{authent:[0,3],authprovid:4,backend:[0,2,5],carta:[0,1,4,5],configur:[0,4,5],control:[0,1,2,5],creat:5,depend:[3,5],directori:[0,5],extern:4,focal:5,fossa:5,frontend:2,futur:3,gener:[],get:3,googl:4,help:3,instal:[2,5],instruct:5,introduct:3,kei:[],keyalgorithm:4,ldap:4,local:4,nginx:[0,5],other:5,packag:5,permiss:[0,5],pm2:5,requir:5,run:[2,5],schema:4,script:5,set:5,startup:5,step:5,support:3,system:0,ubuntu:5,work:3}})

package/docs/_build/html/ubuntu_focal_instructions.html

@@ -7,7 +7,7 @@
   
   <meta name="viewport" content="width=device-width, initial-scale=1.0">
   
-  <title>Step-by-step instructions for Ubuntu 20.04.2 (Focal Fossa) &mdash; CARTA Controller 2.0 documentation</title>
+  <title>Step-by-step instructions for Ubuntu 20.04.2 (Focal Fossa) &mdash; CARTA Controller 3.0.0-beta.1d documentation</title>
   
 
   
@@ -225,7 +225,7 @@ sudo visudo -f /etc/sudoers.d/carta_controller
 <h2>Install CARTA controller<a class="headerlink" href="#install-carta-controller" title="Permalink to this headline">¶</a></h2>
 <div class="admonition note">
 <p class="admonition-title">Note</p>
-<p>Currently supported versions of NodeJS are v12, v14 and v16. In the example below we install the latest LTS version of NodeJS from the NodeSource repo. Do not pass the <code class="docutils literal notranslate"><span class="pre">--unsafe-perm</span></code> flag to <code class="docutils literal notranslate"><span class="pre">npm</span></code> if using a local install.</p>
+<p>Currently supported versions of NodeJS are v12, v14 and v16. In the example below we install the latest LTS version of NodeJS from the <a class="reference external" href="https://github.com/nodesource/distributions">NodeSource repo</a>. Do not pass the <code class="docutils literal notranslate"><span class="pre">--unsafe-perm</span></code> flag to <code class="docutils literal notranslate"><span class="pre">npm</span></code> if using a local install.</p>
 </div>
 <div class="highlight-shell notranslate"><div class="highlight"><pre><span></span><span class="c1"># Install the latest NodeJS LTS repo</span>
 curl -fsSL https://deb.nodesource.com/setup_lts.x <span class="p">|</span> sudo -E bash -

package/docs/src/configuration.rst

@@ -26,7 +26,10 @@ To provide the ``carta`` user with these privileges, you must make modifications
 
 .. warning::
     Please only edit your sudoers configuration with ``visudo`` or equivalent.
-    
+
+.. note::
+    Older versions of ``sudo`` do not support the ``--preserve-env=VARIABLE`` argument. If your version of ``sudo`` is too old, set ``"preserveEnv"`` to ``false`` in your controller configuration, and add ``Defaults env_keep += "CARTA_AUTH_TOKEN"`` to your sudoers configuration.
+
 .. _config-authentication:
 
 Authentication

package/package.json

@@ -1,6 +1,6 @@
 {
     "name": "carta-controller",
-    "version": "2.0.2",
+    "version": "2.0.5",
     "description": "NodeJS-based controller for CARTA",
     "repository": "https://github.com/CARTAvis/carta-controller",
     "homepage": "https://www.cartavis.org",

package/config/testLayout.json

@@ -1,125 +0,0 @@
-{
-    "$schema": "./layout_schema_2.json",
-    "layoutVersion": 2,
-    "docked": {
-        "type": "row",
-        "content": [
-            {
-                "type": "column",
-                "content": [
-                    {
-                        "type": "stack",
-                        "content": [
-                            {
-                                "type": "component",
-                                "id": "image-view",
-                                "height": 71.03496870713306
-                            }
-                        ],
-                        "activeItemIndex": 0,
-                        "height": 71.03496870713306
-                    },
-                    {
-                        "type": "stack",
-                        "content": [
-                            {
-                                "type": "component",
-                                "id": "render-config",
-                                "widgetSettings": {
-                                    "primaryLineColor": "auto-blue",
-                                    "lineWidth": 1,
-                                    "linePlotPointSize": 1.5,
-                                    "logScaleY": true,
-                                    "markerTextVisible": true,
-                                    "meanRmsVisible": true,
-                                    "plotType": "Steps",
-                                    "minXVal": 0,
-                                    "maxXVal": 0,
-                                    "minYVal": 0,
-                                    "maxYVal": 0
-                                }
-                            }
-                        ],
-                        "activeItemIndex": 0,
-                        "height": 28.96503129286694
-                    }
-                ],
-                "width": 60
-            },
-            {
-                "type": "column",
-                "content": [
-                    {
-                        "type": "stack",
-                        "content": [
-                            {
-                                "type": "component",
-                                "id": "spatial-profiler",
-                                "widgetSettings": {
-                                    "coordinate": "x",
-                                    "primaryLineColor": "auto-blue",
-                                    "lineWidth": 1,
-                                    "linePlotPointSize": 1.5,
-                                    "wcsAxisVisible": true,
-                                    "meanRmsVisible": false,
-                                    "plotType": "Steps",
-                                    "minXVal": 0,
-                                    "maxXVal": 0,
-                                    "minYVal": 0,
-                                    "maxYVal": 0
-                                }
-                            }
-                        ],
-                        "activeItemIndex": 0,
-                        "height": 33.333333333333336
-                    },
-                    {
-                        "type": "stack",
-                        "content": [
-                            {
-                                "type": "component",
-                                "id": "spatial-profiler",
-                                "widgetSettings": {
-                                    "coordinate": "y",
-                                    "primaryLineColor": "auto-blue",
-                                    "lineWidth": 1,
-                                    "linePlotPointSize": 1.5,
-                                    "wcsAxisVisible": true,
-                                    "meanRmsVisible": false,
-                                    "plotType": "Steps",
-                                    "minXVal": 0,
-                                    "maxXVal": 0,
-                                    "minYVal": 0,
-                                    "maxYVal": 0
-                                }
-                            }
-                        ],
-                        "activeItemIndex": 0,
-                        "height": 33.333333333333336
-                    },
-                    {
-                        "type": "stack",
-                        "content": [
-                            {
-                                "type": "component",
-                                "id": "layer-list"
-                            },
-                            {
-                                "type": "component",
-                                "id": "animator"
-                            },
-                            {
-                                "type": "component",
-                                "id": "region-list"
-                            }
-                        ],
-                        "activeItemIndex": 0,
-                        "height": 33.333333333333336
-                    }
-                ],
-                "width": 40
-            }
-        ]
-    },
-    "floating": []
-}