[{"data":1,"prerenderedAt":464},["ShallowReactive",2],{"docs-admin\u002Fgettingstarted":3,"navigation":406},{"id":4,"title":5,"body":6,"description":372,"extension":399,"meta":400,"navigation":401,"path":402,"seo":403,"stem":404,"__hash__":405},"docs\u002F2.admin\u002F1.gettingstarted.md","Generic Installation",{"type":7,"value":8,"toc":384},"minimark",[9,13,18,23,123,127,131,155,159,171,175,178,182,185,191,266,270,277,338,342,345,349,352,363,373],[10,11,5],"h1",{"id":12},"generic-installation",[14,15,17],"h2",{"id":16},"installation","Installation",[19,20,22],"h3",{"id":21},"postgresql-database-setup-linux","PostgreSQL Database Setup (Linux)",[24,25,26,35,55,70,85,114],"ol",{},[27,28,29,30,34],"li",{},"Install PostgreSQL (Any version greater and 12 ",[31,32,33],"code",{},"sudo apt install postgresql postgis",")",[27,36,37,38,41,42,45,46],{},"Access the postgres service ",[31,39,40],{},"sudo -u postgres psql"," to confirm it is configured ",[31,43,44],{},"\\q"," to quit\n",[47,48,49],"ul",{},[27,50,51,52],{},"If this does not work, you will need to start the service using ",[31,53,54],{},"sudo service postgresql start",[27,56,57,61,62,65,66,69],{},[58,59,60],"span",{},"Required"," Create a database for udServer to use (",[31,63,64],{},"sudo -u postgres createdb udserverdb",") (or replace ",[31,67,68],{},"udserverdb"," can be any database name of your choosing, you can configure which database to connect to in Configuring udServer below)",[27,71,72,73,76,77,80,81,84],{},"Create a user ",[31,74,75],{},"sudo -u postgres createuser udserveruser"," (or replace ",[31,78,79],{},"udserveruser"," with another user name, or optionally use existing ",[31,82,83],{},"postgres"," user instead)",[27,86,87,88,90,91],{},"Set password and grant user permissions by first running ",[31,89,40],{}," and then run the following:\n",[24,92,93,104,109],{},[27,94,95,96,99,100,103],{},"Run ",[31,97,98],{},"ALTER USER udserveruser WITH PASSWORD '\u003Cpassword>';"," (replacing ",[31,101,102],{},"\u003Cpassword>"," with the desired password) to set the password",[27,105,95,106],{},[31,107,108],{},"GRANT ALL PRIVILEGES ON DATABASE udserverdb TO udserveruser;",[27,110,111,112],{},"Quit using ",[31,113,44],{},[27,115,116,117,120,121],{},"Confirm password has been changed by running ",[31,118,119],{},"psql -h 127.0.0.1 -U udserveruser udserverdb",", entering the password you set above and then quit using ",[31,122,44],{},[19,124,126],{"id":125},"udserver-setup-windows","udServer Setup (Windows)",[128,129,130],"p",{},"This assumes the database is located on another machine, see above for steps.",[47,132,133,143,146,152],{},[27,134,135,136],{},"Install the x64 Visual C++ Redistributable Packages for Visual Studio 2013 from ",[137,138,142],"a",{"href":139,"rel":140},"https:\u002F\u002Fwww.microsoft.com\u002Fdownload\u002Fdetails.aspx?id=40784",[141],"nofollow","here",[27,144,145],{},"Unpack udServer zip into your preferred location",[27,147,148,149],{},"Configure a service using the following in Powershell ",[31,150,151],{},"New-Service -Name \"udServer\" -DisplayName \"udServer\" -BinaryPathName \"\u003CudServer location>\\udServer.exe\" -StartupType Automatic",[27,153,154],{},"Start the service if it's not already running",[19,156,158],{"id":157},"udserver-setup-linux","udServer Setup (Linux)",[47,160,161],{},[27,162,163,164,167,168],{},"Install the ",[31,165,166],{},"udserver_1.0.0-1.deb"," package using the command ",[31,169,170],{},"dpkg -i udserver_1.0.0-1.deb",[14,172,174],{"id":173},"configuring-udserver","Configuring udServer",[128,176,177],{},"... config.json & licenses.json ...",[19,179,181],{"id":180},"server-information","Server Information",[128,183,184],{},"This information is the general settings for this server.",[186,187,188],"blockquote",{},[128,189,190],{},"We do not recommend udServer handling SSL connections on production servers with more than 100 concurrent users. A reverse proxy or load balancer can handle this more efficiently.",[47,192,193,207,217,230,239,248,257],{},[27,194,195,198,199,202,203,206],{},[31,196,197],{},"Server name"," is the friendly name of this server, generally ",[31,200,201],{},"Nuclideon udServer"," or a region based name would ",[31,204,205],{},"SYD-WIN-UD-053"," would be expected",[27,208,209,212,213,216],{},[31,210,211],{},"Server Address"," is the listen address of the server. Unless you have a complex shared server, ",[31,214,215],{},"0.0.0.0"," is recommended.",[27,218,219,222,223,226,227],{},[31,220,221],{},"HTTP Mode"," is what do to when someone connects via ",[31,224,225],{},"HTTP:\u002F\u002F"," instead of ",[31,228,229],{},"HTTPS:\u002F\u002F",[27,231,232,235,236],{},[31,233,234],{},"HTTP Port"," is the port to listen on if HTTP is enabled. Recommended is ",[31,237,238],{},"80",[27,240,241,244,245,216],{},[31,242,243],{},"HTTPS Port"," is the port to listen on for HTTPS traffic. Port ",[31,246,247],{},"443",[27,249,250,253,254],{},[31,251,252],{},"SSL Public Certificate"," is the SSL certificate to use for HTTPS traffic. It will usually begin with ",[31,255,256],{},"-----BEGIN CERIFICATE-----",[27,258,259,262,263],{},[31,260,261],{},"SSL Private Key"," is the SSL private key, it generally begins with ",[31,264,265],{},"-----BEGIN PRIVATE KEY-----",[19,267,269],{"id":268},"postgresql-database","PostgreSQL Database",[128,271,272,273,276],{},"Euclideon udServer uses a PostgreSQL database (9 or higher) for storing everything and is unable to work without it. The server must be configured with ",[31,274,275],{},"pgcrypto"," extension installed.",[47,278,279,293,302,308,314,324],{},[27,280,281,284,285,288,289,292],{},[31,282,283],{},"Host"," is the database host ",[31,286,287],{},"postgres.local"," or ",[31,290,291],{},"10.4.1.250"," are expected results",[27,294,295,298,299],{},[31,296,297],{},"Port"," is the database post, by default PostgreSQL uses ",[31,300,301],{},"5432",[27,303,304,307],{},[31,305,306],{},"Username"," is the database user",[27,309,310,313],{},[31,311,312],{},"Password"," is the database password, it is required and there is no default",[27,315,316,319,320,323],{},[31,317,318],{},"Database Name"," is the name of the database Euclideon udServer will use, ",[31,321,322],{},"udserver"," is recommended",[27,325,326,329,330,333,334,337],{},[31,327,328],{},"Active Database Connections"," is the number of pooled connections udServer will maintain in order to respond quickly to requests. ",[31,331,332],{},"10"," is recommended and less than ",[31,335,336],{},"4"," is likely to degrade performance.",[19,339,341],{"id":340},"first-launch","First Launch",[128,343,344],{},"Once the server starts, when connecting you will be prompted for OIDC connection information.",[14,346,348],{"id":347},"setting-up-as-a-service","Setting up as a service",[128,350,351],{},"If not using the Docker image you can register udServer as a service using the standard service system.",[128,353,354,355,358,359,362],{},"Here is a template ",[31,356,357],{},"udServer.service"," file for Ubuntu which you can put in ",[31,360,361],{},"\u002Fetc\u002Fsystemd\u002Fsystem\u002F",".",[364,365,370],"pre",{"className":366,"code":368,"language":369},[367],"language-text","[Unit]\nDescription=Nuclideon udServer\nStartLimitInterval=200\nStartLimitBurst=5\n\n[Service]\nWorkingDirectory=\u002Fopt\u002Fudserver\nExecStart=\u002Fopt\u002Fudserver\u002FudServer\nSyslogLevelPrefix=false\nType=idle\nRestart=on-failure\nRestartSec=30\n\n[Install]\nWantedBy=multi-user.target\n","text",[31,371,368],{"__ignoreMap":372},"",[128,374,375,376,379,380,383],{},"After you create the file don't forget to ",[31,377,378],{},"sudo systemctl daemon-reload"," and ",[31,381,382],{},"sudo systemctl start udServer","!",{"title":372,"searchDepth":385,"depth":385,"links":386},2,[387,393,398],{"id":16,"depth":385,"text":17,"children":388},[389,391,392],{"id":21,"depth":390,"text":22},3,{"id":125,"depth":390,"text":126},{"id":157,"depth":390,"text":158},{"id":173,"depth":385,"text":174,"children":394},[395,396,397],{"id":180,"depth":390,"text":181},{"id":268,"depth":390,"text":269},{"id":340,"depth":390,"text":341},{"id":347,"depth":385,"text":348},"md",{},true,"\u002Fadmin\u002Fgettingstarted",{"title":5,"description":372},"2.admin\u002F1.gettingstarted","QSzxkfl0EtzDXUrp8UTcdK7wMHkqIjka0nesMvsm890",[407,411,440,455],{"title":408,"path":409,"stem":410},"udServer Manuals","\u002F","0.index",{"title":412,"path":413,"stem":414,"children":415},"User Guide","\u002Fdocs\u002Fuser","1.user\u002F0.index",[416,420,424,428,432,436],{"title":417,"path":418,"stem":419},"Login","\u002Fdocs\u002Fuser\u002Flogin","1.user\u002F1.login",{"title":421,"path":422,"stem":423},"3rd Party Licenses","\u002Fdocs\u002Fuser\u002Flicenses","1.user\u002Flicenses",{"title":425,"path":426,"stem":427},"Organisations","\u002Fdocs\u002Fuser\u002Forganisations","1.user\u002Forganisations",{"title":429,"path":430,"stem":431},"Permissions","\u002Fdocs\u002Fuser\u002Fpermissions","1.user\u002Fpermissions",{"title":433,"path":434,"stem":435},"Connecting an AWS S3 Bucket to a Project","\u002Fdocs\u002Fuser\u002Fproject-s3-setup","1.user\u002Fproject-s3-setup",{"title":437,"path":438,"stem":439},"Organisation Projects","\u002Fdocs\u002Fuser\u002Fprojects","1.user\u002Fprojects",{"title":441,"path":442,"stem":443,"children":444},"IT Administrators Guide","\u002Fdocs\u002Fadmin","2.admin\u002F0.index",[445,447,451],{"title":5,"path":446,"stem":404},"\u002Fdocs\u002Fadmin\u002Fgettingstarted",{"title":448,"path":449,"stem":450},"Setting up on an Amazon EC2 instance","\u002Fdocs\u002Fadmin\u002Famazon-ec2","2.admin\u002F2.amazon-ec2",{"title":452,"path":453,"stem":454},"Configuring OAuth \u002F OIDC Authentication","\u002Fdocs\u002Fadmin\u002Foauth","2.admin\u002F3.oauth",{"title":456,"path":457,"stem":458,"children":459},"Developers Guide","\u002Fdocs\u002Fdev","3.dev\u002F0.index",[460],{"title":461,"path":462,"stem":463},"udServer API","\u002Fdocs\u002Fdev\u002Fudserverapi","3.dev\u002FudServerAPI",1779890364915]