From 536f22f3d2593bcbb0ce0b9c9b2a8cc381ccc98c Mon Sep 17 00:00:00 2001 From: stefanv Date: Tue, 19 Dec 2023 19:24:08 +0000 Subject: [PATCH] =?UTF-8?q?Deploying=20to=20gh-pages=20from=20=20@=204d437?= =?UTF-8?q?5ced99b0091ce23f7d03e3dec2ffb3d5832=20=F0=9F=9A=80?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- _sources/setup.md.txt | 12 +++++++----- _static/basic.css | 18 ++++++++++++++++++ _static/pygments.css | 1 + dev.html | 22 ++++++++++++---------- extending.html | 22 ++++++++++++---------- genindex.html | 20 +++++++++++--------- index.html | 22 ++++++++++++---------- search.html | 20 +++++++++++--------- searchindex.js | 2 +- setup.html | 33 ++++++++++++++++++--------------- usage.html | 22 ++++++++++++---------- 11 files changed, 115 insertions(+), 79 deletions(-) diff --git a/_sources/setup.md.txt b/_sources/setup.md.txt index d54d5be2..1c72c4a8 100644 --- a/_sources/setup.md.txt +++ b/_sources/setup.md.txt @@ -39,16 +39,18 @@ See [below](#configuration) for more information on modifying the baselayer conf - Using `apt-get`: `sudo apt-get install nginx supervisor postgresql libpq-dev npm nodejs-legacy` - It may be necessary to configure your database permissions: at - the end of your `pg_hba.conf` (typically in `/etc/postgresql/13.3/main`), + the end of your `pg_hba.conf` (typically in `/etc/postgresql/13.3/main` or `/var/lib/pgsql/data`), add the following lines and restart PostgreSQL - (`sudo service postgresql restart`): + (`sudo service postgresql restart` or `systemctl reload postgresql`): ``` - local all postgres peer - local baselayer baselayer trust - local baselayer_test baselayer trust + # CONNECTION DATABASE USER ADDRESS METHOD + host template_app template_app localhost trust + host all postgres localhost trust ``` + Substitute the correct database name and user, as defined in your `config.yaml`. + ## Building the baselayer database - Initialize the database with `make db_init` (also tests that your diff --git a/_static/basic.css b/_static/basic.css index 7577acb1..cfc60b86 100644 --- a/_static/basic.css +++ b/_static/basic.css @@ -670,6 +670,16 @@ dd { margin-left: 30px; } +.sig dd { + margin-top: 0px; + margin-bottom: 0px; +} + +.sig dl { + margin-top: 0px; + margin-bottom: 0px; +} + dl > dd:last-child, dl > dd:last-child > :last-child { margin-bottom: 0; @@ -738,6 +748,14 @@ abbr, acronym { cursor: help; } +.translated { + background-color: rgba(207, 255, 207, 0.2) +} + +.untranslated { + background-color: rgba(255, 207, 207, 0.2) +} + /* -- code displays --------------------------------------------------------- */ pre { diff --git a/_static/pygments.css b/_static/pygments.css index 691aeb82..0d49244e 100644 --- a/_static/pygments.css +++ b/_static/pygments.css @@ -17,6 +17,7 @@ span.linenos.special { color: #000000; background-color: #ffffc0; padding-left: .highlight .cs { color: #408090; background-color: #fff0f0 } /* Comment.Special */ .highlight .gd { color: #A00000 } /* Generic.Deleted */ .highlight .ge { font-style: italic } /* Generic.Emph */ +.highlight .ges { font-weight: bold; font-style: italic } /* Generic.EmphStrong */ .highlight .gr { color: #FF0000 } /* Generic.Error */ .highlight .gh { color: #000080; font-weight: bold } /* Generic.Heading */ .highlight .gi { color: #00A000 } /* Generic.Inserted */ diff --git a/dev.html b/dev.html index 1e167820..5bfe23c2 100644 --- a/dev.html +++ b/dev.html @@ -1,22 +1,24 @@ - + - + Developer notes — baselayer vUndefined documentation - - - + + + + + - - - - - + + + + + diff --git a/extending.html b/extending.html index b556f0a8..c2f447df 100644 --- a/extending.html +++ b/extending.html @@ -1,22 +1,24 @@ - + - + Extending baselayer — baselayer vUndefined documentation - - - + + + + + - - - - - + + + + + diff --git a/genindex.html b/genindex.html index e4c4b84c..80874cb9 100644 --- a/genindex.html +++ b/genindex.html @@ -1,21 +1,23 @@ - + Index — baselayer vUndefined documentation - - - + + + + + - - - - - + + + + + diff --git a/index.html b/index.html index 9afef14e..50f83f15 100644 --- a/index.html +++ b/index.html @@ -1,22 +1,24 @@ - + - + Baselayer — baselayer vUndefined documentation - - - + + + + + - - - - - + + + + + diff --git a/search.html b/search.html index ff8b6670..67bd7a16 100644 --- a/search.html +++ b/search.html @@ -1,22 +1,24 @@ - + Search — baselayer vUndefined documentation - - - + + + + + - - - - - + + + + + diff --git a/searchindex.js b/searchindex.js index 82994dac..962c8dad 100644 --- a/searchindex.js +++ b/searchindex.js @@ -1 +1 @@ -Search.setIndex({"docnames": ["dev", "extending", "index", "setup", "usage"], "filenames": ["dev.md", "extending.md", "index.rst", "setup.md", "usage.md"], "titles": ["Developer notes", "Extending baselayer", "Baselayer", "Setup", "Usage"], "terms": {"To": [0, 1], "execut": 0, "suit": 0, "instal": [0, 2], "chromedriv": 0, "from": [0, 1, 3, 4], "http": 0, "site": [0, 4], "googl": [0, 3], "com": 0, "chromium": 0, "org": 0, "home": 0, "chrome": 0, "run": [0, 1, 3], "all": [0, 1, 3, 4], "make": [0, 3], "singl": 0, "tool": [0, 1], "test_frontend": 0, "py": [0, 1, 4], "skportal": 0, "frontend": 0, "test_fil": 0, "test_": 0, "specific_test": 0, "On": 0, "linux": 0, "can": [0, 1, 3, 4], "headless": 0, "mode": 0, "browser": 0, "displai": 0, "xfvb": 0, "sudo": [0, 3], "apt": [0, 3], "get": [0, 3], "test_headless": 0, "log": [0, 1, 3], "watch": 0, "output": 0, "stop": 0, "ani": [0, 1, 4], "web": [0, 1, 4], "servic": [0, 3, 4], "attach": 0, "webserv": 0, "e": [0, 4], "g": [0, 4], "us": [0, 1, 3, 4], "pdb": 0, "set_trac": 0, "check": 0, "j": [0, 1, 3], "updat": [0, 1], "see": [0, 3, 4], "which": [0, 4], "packag": 0, "ar": [0, 4], "elig": 0, "an": [0, 3, 4], "interact": 0, "perform": [0, 4], "wai": [0, 4], "sqlalchemi": 0, "pyscopg2": 0, "backend": 0, "some": 0, "necessarili": 0, "obviou": 0, "usag": [0, 2], "pattern": 0, "we": [0, 4], "includ": [0, 1, 4], "logic": 0, "connect": 0, "db": 0, "refresh": 0, "tabl": 0, "etc": [0, 1, 3, 4], "i": [0, 1, 3, 4], "found": 0, "baselay": [0, 4], "model_util": 0, "app": [0, 1, 3, 4], "env": 0, "import": [0, 1], "load_env": 0, "model": 0, "dbsession": 0, "init_db": 0, "cfg": 0, "The": [0, 1, 3, 4], "session": 0, "object": 0, "control": [0, 4], "variou": 0, "state": 0, "oper": [0, 3], "add": [0, 1, 3, 4], "obj": 0, "commit": 0, "modif": 0, "rollback": 0, "recov": 0, "after": 0, "error": 0, "gener": 0, "applic": [0, 2, 3, 4], "base": 0, "class": 0, "to_dict": 0, "__str__": 0, "overridden": [0, 3], "within": 0, "specif": [0, 1, 4], "directli": 0, "user": [0, 3, 4], "queri": 0, "more": [0, 3], "construct": 0, "via": 0, "id": 0, "conveni": 0, "function": [0, 1, 4], "join": 0, "relationship": 0, "multi": 0, "step": 0, "defin": 0, "through": [0, 4], "secondari": 0, "paramet": [0, 1], "elimin": 0, "intermedi": 0, "acl": [0, 4], "instad": 0, "r": [0, 1], "role": [0, 4], "associ": 0, "proxi": 0, "shortcut": 0, "attribut": 0, "relat": 0, "permiss": [0, 2, 3], "instead": [0, 3, 4], "load": [0, 3, 4], "thi": [0, 1, 3, 4], "allow": [0, 4], "also": [0, 3, 4], "child": 0, "often": [0, 1], "handler": [0, 1, 4], "when": [0, 1], "know": 0, "inform": [0, 3, 4], "about": 0, "need": [0, 1, 3, 4], "to_json": 0, "return": [0, 1], "orm": 0, "convert": 0, "json": 0, "json_util": 0, "children": 0, "were": 0, "joinedload": 0, "access": [0, 4], "them": [0, 4], "For": [0, 3, 4], "exampl": [0, 3, 4], "first": [0, 1], "contain": [0, 1], "": 0, "u": 0, "doe": 0, "list": 0, "start": [0, 3], "without": 0, "verif": 0, "context": 0, "manag": 0, "sure": 0, "close": 0, "exit": 0, "verifi": 0, "row": 0, "befor": [0, 1, 3, 4], "verifiedsess": 0, "user_or_token": 0, "same": [0, 4], "call": 0, "self": 0, "verify_and_commit": 0, "each": 0, "stand": [0, 4], "current_us": 0, "quickli": 0, "method": 0, "one": 0, "replac": 0, "id_or_list": 0, "read": 0, "raise_if_non": 0, "fals": 0, "option": [0, 2], "all_us": 0, "get_al": 0, "column": 0, "none": 0, "stmt": 0, "columnn": 0, "open": 0, "intern": 0, "retriev": 0, "specifi": [0, 1], "thei": 0, "In": [0, 4], "case": [0, 4], "given": 0, "scalar": 0, "do": [0, 1, 4], "exist": 0, "rais": 0, "accesserror": 0, "true": 0, "just": 0, "two": [0, 4], "produc": 0, "extern": 0, "thu": 0, "made": [0, 4], "while": 0, "ha": 0, "ad": 0, "addit": [0, 1], "save": 0, "other": [0, 3, 4], "involv": 0, "As": 0, "user_id": 0, "must": 0, "have": [0, 1, 3, 4], "token": 0, "fail": 0, "hand": 0, "onli": [0, 4], "further": 0, "filter": 0, "where": 0, "tupl": 0, "name": [0, 1], "new_nam": 0, "If": [0, 3], "argument": [0, 1], "eslint": 0, "ensur": 0, "our": 0, "jsx": [0, 1], "code": [0, 1], "consist": 0, "conform": 0, "recommend": 0, "lint": 0, "git": 0, "pre": 0, "hook": 0, "so": [0, 1, 4], "check_js_upd": 0, "sh": 0, "script": 0, "npm": [0, 3], "search": 0, "It": [0, 3], "provid": [0, 1, 3, 4], "interfac": 0, "version": [0, 3], "A": [1, 3, 4], "python": [1, 3], "configur": [1, 2, 4], "factori": 1, "creat": [1, 4], "rout": 1, "certain": [1, 4], "setup": [1, 2], "procedur": 1, "should": [1, 3], "follow": [1, 3], "signatur": 1, "def": 1, "make_app": 1, "config": [1, 3, 4], "baselayer_handl": 1, "baselayer_set": 1, "pass": 1, "those": 1, "append": 1, "your": [1, 3], "put": 1, "place": 1, "system": [1, 3, 4], "endpoint": 1, "last": 1, "typic": [1, 3], "could": 1, "app_serv": 1, "mainpagehandl": 1, "my_pag": 1, "mypagehandl": 1, "set": [1, 3, 4], "tornado_config_kei": 1, "tornado_config_valu": 1, "here": 1, "valu": 1, "insid": 1, "javascript": [1, 2], "engin": 1, "file": [1, 3, 4], "nginx": [1, 3, 4], "supervisor": [1, 3, 4], "depend": [1, 2, 3], "yaml": [1, 3, 4], "simplifi": 1, "propag": 1, "appli": 1, "jinja2": 1, "inject": [1, 4], "you": [1, 3, 4], "databas": [1, 2], "port": 1, "launch": [1, 2, 4], "run_product": 1, "target": 1, "automat": [1, 3], "fill": 1, "out": 1, "altern": 1, "manual": [1, 3], "fill_conf_valu": 1, "static": 1, "compon": 1, "build": 2, "deploy": 2, "develop": 2, "note": 2, "test": [2, 3], "debug": 2, "new": [2, 4], "sql": 2, "alchemi": 2, "2": 2, "0": 2, "style": 2, "select": 2, "statement": 2, "standard": 2, "upgrad": 2, "microservic": 2, "extend": 2, "modifi": [2, 3], "tornado": 2, "templat": [2, 3, 4], "guid": 3, "describ": 3, "how": 3, "webapp": 3, "deriv": 3, "up": 3, "simpl": 3, "clone": 3, "proce": 3, "instruct": 3, "3": 3, "8": 3, "later": 3, "requir": 3, "postgresql": 3, "node": 3, "homebrew": 3, "brew": 3, "server": [3, 4], "login": 3, "pg_ctl": 3, "d": [3, 4], "usr": 3, "local": 3, "var": 3, "postgr": 3, "macport": 3, "realip": 3, "postgresql13": 3, "npm7": 3, "default": [3, 4], "5000": 3, "avail": 3, "free": 3, "latest": 3, "monterei": 3, "anoth": 3, "mai": 3, "5700": 3, "below": 3, "libpq": 3, "dev": 3, "nodej": 3, "legaci": 3, "necessari": 3, "end": 3, "pg_hba": 3, "conf": [3, 4], "13": 3, "main": 3, "line": 3, "restart": 3, "peer": 3, "trust": 3, "baselayer_test": 3, "initi": 3, "db_init": 3, "been": [3, 4], "properli": 3, "navig": 3, "localhost": 3, "differ": 3, "portnumb": 3, "custom": [3, 4], "alwai": 3, "secret_kei": 3, "want": 3, "abl": 3, "auth": 3, "credenti": 3, "obtain": 3, "flag": 3, "environ": 3, "variabl": 3, "myconfig": 3, "premier": 4, "skyport": 4, "sever": 4, "piec": 4, "implement": 4, "backport": 4, "yet": 4, "pleas": 4, "refer": 4, "document": 4, "featur": 4, "like": 4, "issu": 4, "bring": 4, "resourc": 4, "wide": 4, "action": 4, "upload": 4, "spectra": 4, "post": 4, "comment": 4, "group": 4, "sourc": 4, "member": 4, "admin": 4, "give": 4, "belong": 4, "multipl": 4, "alon": 4, "micro": 4, "whenev": 4, "possibl": 4, "These": 4, "monitor": 4, "supervisord": 4, "cron": 4, "job": 4, "websocket": 4, "discov": 4, "path": 4, "enabl": 4, "disabl": 4, "live": 4, "directori": 4, "entir": 4, "By": 4, "kei": 4, "would": 4, "sometim": 4, "therefor": 4, "compil": 4, "dask": 4}, "objects": {}, "objtypes": {}, "objnames": {}, "titleterms": {"develop": 0, "note": 0, "test": 0, "debug": 0, "databas": [0, 3], "new": 0, "sql": 0, "alchemi": 0, "2": 0, "0": 0, "style": 0, "select": 0, "statement": 0, "standard": 0, "upgrad": 0, "javascript": 0, "depend": 0, "extend": 1, "baselay": [1, 2, 3], "modifi": 1, "tornado": 1, "applic": 1, "templat": 1, "setup": 3, "instal": 3, "On": 3, "maco": 3, "port": 3, "number": 3, "configur": 3, "linux": 3, "build": 3, "launch": 3, "deploy": 3, "option": 3, "usag": 4, "permiss": 4, "microservic": 4}, "envversion": {"sphinx.domains.c": 2, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 8, "sphinx.domains.index": 1, "sphinx.domains.javascript": 2, "sphinx.domains.math": 2, "sphinx.domains.python": 3, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 57}, "alltitles": {"Developer notes": [[0, "developer-notes"]], "Testing": [[0, "testing"]], "Debugging": [[0, "debugging"]], "Database": [[0, "database"]], "New SQL Alchemy 2.0 style select statements": [[0, "new-sql-alchemy-2-0-style-select-statements"]], "Standards": [[0, "standards"]], "Upgrading Javascript dependencies": [[0, "upgrading-javascript-dependencies"]], "Extending baselayer": [[1, "extending-baselayer"]], "Modifying the Tornado application": [[1, "modifying-the-tornado-application"]], "Templating": [[1, "templating"]], "Baselayer": [[2, "baselayer"]], "Setup": [[3, "setup"]], "Installation": [[3, "installation"]], "On macOS": [[3, "on-macos"]], "Port Number Configuration with macOS": [[3, "port-number-configuration-with-macos"]], "On Linux": [[3, "on-linux"]], "Building the baselayer database": [[3, "building-the-baselayer-database"]], "Configuration": [[3, "configuration"]], "Launch": [[3, "launch"]], "Deployment options": [[3, "deployment-options"]], "Usage": [[4, "usage"]], "Permissions": [[4, "permissions"]], "Microservices": [[4, "microservices"]]}, "indexentries": {}}) \ No newline at end of file +Search.setIndex({"docnames": ["dev", "extending", "index", "setup", "usage"], "filenames": ["dev.md", "extending.md", "index.rst", "setup.md", "usage.md"], "titles": ["Developer notes", "Extending baselayer", "Baselayer", "Setup", "Usage"], "terms": {"To": [0, 1], "execut": 0, "suit": 0, "instal": [0, 2], "chromedriv": 0, "from": [0, 1, 3, 4], "http": 0, "site": [0, 4], "googl": [0, 3], "com": 0, "chromium": 0, "org": 0, "home": 0, "chrome": 0, "run": [0, 1, 3], "all": [0, 1, 3, 4], "make": [0, 3], "singl": 0, "tool": [0, 1], "test_frontend": 0, "py": [0, 1, 4], "skportal": 0, "frontend": 0, "test_fil": 0, "test_": 0, "specific_test": 0, "On": 0, "linux": 0, "can": [0, 1, 3, 4], "headless": 0, "mode": 0, "browser": 0, "displai": 0, "xfvb": 0, "sudo": [0, 3], "apt": [0, 3], "get": [0, 3], "test_headless": 0, "log": [0, 1, 3], "watch": 0, "output": 0, "stop": 0, "ani": [0, 1, 4], "web": [0, 1, 4], "servic": [0, 3, 4], "attach": 0, "webserv": 0, "e": [0, 4], "g": [0, 4], "us": [0, 1, 3, 4], "pdb": 0, "set_trac": 0, "check": 0, "j": [0, 1, 3], "updat": [0, 1], "see": [0, 3, 4], "which": [0, 4], "packag": 0, "ar": [0, 4], "elig": 0, "an": [0, 3, 4], "interact": 0, "perform": [0, 4], "wai": [0, 4], "sqlalchemi": 0, "pyscopg2": 0, "backend": 0, "some": 0, "necessarili": 0, "obviou": 0, "usag": [0, 2], "pattern": 0, "we": [0, 4], "includ": [0, 1, 4], "logic": 0, "connect": [0, 3], "db": 0, "refresh": 0, "tabl": 0, "etc": [0, 1, 3, 4], "i": [0, 1, 3, 4], "found": 0, "baselay": [0, 4], "model_util": 0, "app": [0, 1, 3, 4], "env": 0, "import": [0, 1], "load_env": 0, "model": 0, "dbsession": 0, "init_db": 0, "cfg": 0, "The": [0, 1, 3, 4], "session": 0, "object": 0, "control": [0, 4], "variou": 0, "state": 0, "oper": [0, 3], "add": [0, 1, 3, 4], "obj": 0, "commit": 0, "modif": 0, "rollback": 0, "recov": 0, "after": 0, "error": 0, "gener": 0, "applic": [0, 2, 3, 4], "base": 0, "class": 0, "to_dict": 0, "__str__": 0, "overridden": [0, 3], "within": 0, "specif": [0, 1, 4], "directli": 0, "user": [0, 3, 4], "queri": 0, "more": [0, 3], "construct": 0, "via": 0, "id": 0, "conveni": 0, "function": [0, 1, 4], "join": 0, "relationship": 0, "multi": 0, "step": 0, "defin": [0, 3], "through": [0, 4], "secondari": 0, "paramet": [0, 1], "elimin": 0, "intermedi": 0, "acl": [0, 4], "instad": 0, "r": [0, 1], "role": [0, 4], "associ": 0, "proxi": 0, "shortcut": 0, "attribut": 0, "relat": 0, "permiss": [0, 2, 3], "instead": [0, 3, 4], "load": [0, 3, 4], "thi": [0, 1, 3, 4], "allow": [0, 4], "also": [0, 3, 4], "child": 0, "often": [0, 1], "handler": [0, 1, 4], "when": [0, 1], "know": 0, "inform": [0, 3, 4], "about": 0, "need": [0, 1, 3, 4], "to_json": 0, "return": [0, 1], "orm": 0, "convert": 0, "json": 0, "json_util": 0, "children": 0, "were": 0, "joinedload": 0, "access": [0, 4], "them": [0, 4], "For": [0, 3, 4], "exampl": [0, 3, 4], "first": [0, 1], "contain": [0, 1], "": 0, "u": 0, "doe": 0, "list": 0, "start": [0, 3], "without": 0, "verif": 0, "context": 0, "manag": 0, "sure": 0, "close": 0, "exit": 0, "verifi": 0, "row": 0, "befor": [0, 1, 3, 4], "verifiedsess": 0, "user_or_token": 0, "same": [0, 4], "call": 0, "self": 0, "verify_and_commit": 0, "each": 0, "stand": [0, 4], "current_us": 0, "quickli": 0, "method": [0, 3], "one": 0, "replac": 0, "id_or_list": 0, "read": 0, "raise_if_non": 0, "fals": 0, "option": [0, 2], "all_us": 0, "get_al": 0, "column": 0, "none": 0, "stmt": 0, "columnn": 0, "open": 0, "intern": 0, "retriev": 0, "specifi": [0, 1], "thei": 0, "In": [0, 4], "case": [0, 4], "given": 0, "scalar": 0, "do": [0, 1, 4], "exist": 0, "rais": 0, "accesserror": 0, "true": 0, "just": 0, "two": [0, 4], "produc": 0, "extern": 0, "thu": 0, "made": [0, 4], "while": 0, "ha": 0, "ad": 0, "addit": [0, 1], "save": 0, "other": [0, 3, 4], "involv": 0, "As": 0, "user_id": 0, "must": 0, "have": [0, 1, 3, 4], "token": 0, "fail": 0, "hand": 0, "onli": [0, 4], "further": 0, "filter": 0, "where": 0, "tupl": 0, "name": [0, 1, 3], "new_nam": 0, "If": [0, 3], "argument": [0, 1], "eslint": 0, "ensur": 0, "our": 0, "jsx": [0, 1], "code": [0, 1], "consist": 0, "conform": 0, "recommend": 0, "lint": 0, "git": 0, "pre": 0, "hook": 0, "so": [0, 1, 4], "check_js_upd": 0, "sh": 0, "script": 0, "npm": [0, 3], "search": 0, "It": [0, 3], "provid": [0, 1, 3, 4], "interfac": 0, "version": [0, 3], "A": [1, 3, 4], "python": [1, 3], "configur": [1, 2, 4], "factori": 1, "creat": [1, 4], "rout": 1, "certain": [1, 4], "setup": [1, 2], "procedur": 1, "should": [1, 3], "follow": [1, 3], "signatur": 1, "def": 1, "make_app": 1, "config": [1, 3, 4], "baselayer_handl": 1, "baselayer_set": 1, "pass": 1, "those": 1, "append": 1, "your": [1, 3], "put": 1, "place": 1, "system": [1, 3, 4], "endpoint": 1, "last": 1, "typic": [1, 3], "could": 1, "app_serv": 1, "mainpagehandl": 1, "my_pag": 1, "mypagehandl": 1, "set": [1, 3, 4], "tornado_config_kei": 1, "tornado_config_valu": 1, "here": 1, "valu": 1, "insid": 1, "javascript": [1, 2], "engin": 1, "file": [1, 3, 4], "nginx": [1, 3, 4], "supervisor": [1, 3, 4], "depend": [1, 2, 3], "yaml": [1, 3, 4], "simplifi": 1, "propag": 1, "appli": 1, "jinja2": 1, "inject": [1, 4], "you": [1, 3, 4], "databas": [1, 2], "port": 1, "launch": [1, 2, 4], "run_product": 1, "target": 1, "automat": [1, 3], "fill": 1, "out": 1, "altern": 1, "manual": [1, 3], "fill_conf_valu": 1, "static": 1, "compon": 1, "build": 2, "deploy": 2, "develop": 2, "note": 2, "test": [2, 3], "debug": 2, "new": [2, 4], "sql": 2, "alchemi": 2, "2": 2, "0": 2, "style": 2, "select": 2, "statement": 2, "standard": 2, "upgrad": 2, "microservic": 2, "extend": 2, "modifi": [2, 3], "tornado": 2, "templat": [2, 3, 4], "guid": 3, "describ": 3, "how": 3, "webapp": 3, "deriv": 3, "up": 3, "simpl": 3, "clone": 3, "proce": 3, "instruct": 3, "3": 3, "8": 3, "later": 3, "requir": 3, "postgresql": 3, "node": 3, "homebrew": 3, "brew": 3, "server": [3, 4], "login": 3, "pg_ctl": 3, "d": [3, 4], "usr": 3, "local": 3, "var": 3, "postgr": 3, "macport": 3, "realip": 3, "postgresql13": 3, "npm7": 3, "default": [3, 4], "5000": 3, "avail": 3, "free": 3, "latest": 3, "monterei": 3, "anoth": 3, "mai": 3, "5700": 3, "below": 3, "libpq": 3, "dev": 3, "nodej": 3, "legaci": 3, "necessari": 3, "end": 3, "pg_hba": 3, "conf": [3, 4], "13": 3, "main": 3, "lib": 3, "pgsql": 3, "data": 3, "line": 3, "restart": 3, "systemctl": 3, "reload": 3, "address": 3, "host": 3, "template_app": 3, "localhost": 3, "trust": 3, "substitut": 3, "correct": 3, "initi": 3, "db_init": 3, "been": [3, 4], "properli": 3, "navig": 3, "differ": 3, "portnumb": 3, "custom": [3, 4], "alwai": 3, "secret_kei": 3, "want": 3, "abl": 3, "auth": 3, "credenti": 3, "obtain": 3, "flag": 3, "environ": 3, "variabl": 3, "myconfig": 3, "premier": 4, "skyport": 4, "sever": 4, "piec": 4, "implement": 4, "backport": 4, "yet": 4, "pleas": 4, "refer": 4, "document": 4, "featur": 4, "like": 4, "issu": 4, "bring": 4, "resourc": 4, "wide": 4, "action": 4, "upload": 4, "spectra": 4, "post": 4, "comment": 4, "group": 4, "sourc": 4, "member": 4, "admin": 4, "give": 4, "belong": 4, "multipl": 4, "alon": 4, "micro": 4, "whenev": 4, "possibl": 4, "These": 4, "monitor": 4, "supervisord": 4, "cron": 4, "job": 4, "websocket": 4, "discov": 4, "path": 4, "enabl": 4, "disabl": 4, "live": 4, "directori": 4, "entir": 4, "By": 4, "kei": 4, "would": 4, "sometim": 4, "therefor": 4, "compil": 4, "dask": 4}, "objects": {}, "objtypes": {}, "objnames": {}, "titleterms": {"develop": 0, "note": 0, "test": 0, "debug": 0, "databas": [0, 3], "new": 0, "sql": 0, "alchemi": 0, "2": 0, "0": 0, "style": 0, "select": 0, "statement": 0, "standard": 0, "upgrad": 0, "javascript": 0, "depend": 0, "extend": 1, "baselay": [1, 2, 3], "modifi": 1, "tornado": 1, "applic": 1, "templat": 1, "setup": 3, "instal": 3, "On": 3, "maco": 3, "port": 3, "number": 3, "configur": 3, "linux": 3, "build": 3, "launch": 3, "deploy": 3, "option": 3, "usag": 4, "permiss": 4, "microservic": 4}, "envversion": {"sphinx.domains.c": 3, "sphinx.domains.changeset": 1, "sphinx.domains.citation": 1, "sphinx.domains.cpp": 9, "sphinx.domains.index": 1, "sphinx.domains.javascript": 3, "sphinx.domains.math": 2, "sphinx.domains.python": 4, "sphinx.domains.rst": 2, "sphinx.domains.std": 2, "sphinx": 58}, "alltitles": {"Developer notes": [[0, "developer-notes"]], "Testing": [[0, "testing"]], "Debugging": [[0, "debugging"]], "Database": [[0, "database"]], "New SQL Alchemy 2.0 style select statements": [[0, "new-sql-alchemy-2-0-style-select-statements"]], "Standards": [[0, "standards"]], "Upgrading Javascript dependencies": [[0, "upgrading-javascript-dependencies"]], "Extending baselayer": [[1, "extending-baselayer"]], "Modifying the Tornado application": [[1, "modifying-the-tornado-application"]], "Templating": [[1, "templating"]], "Baselayer": [[2, "baselayer"]], "Setup": [[3, "setup"]], "Installation": [[3, "installation"]], "On macOS": [[3, "on-macos"]], "Port Number Configuration with macOS": [[3, "port-number-configuration-with-macos"]], "On Linux": [[3, "on-linux"]], "Building the baselayer database": [[3, "building-the-baselayer-database"]], "Configuration": [[3, "configuration"]], "Launch": [[3, "launch"]], "Deployment options": [[3, "deployment-options"]], "Usage": [[4, "usage"]], "Permissions": [[4, "permissions"]], "Microservices": [[4, "microservices"]]}, "indexentries": {}}) \ No newline at end of file diff --git a/setup.html b/setup.html index 939e7fe8..b83dd77b 100644 --- a/setup.html +++ b/setup.html @@ -1,22 +1,24 @@ - + - + Setup — baselayer vUndefined documentation - - - + + + + + - - - - - + + + + + @@ -139,14 +141,15 @@

On Linuxapt-get: sudo apt-get install nginx supervisor postgresql libpq-dev npm nodejs-legacy

  • It may be necessary to configure your database permissions: at -the end of your pg_hba.conf (typically in /etc/postgresql/13.3/main), +the end of your pg_hba.conf (typically in /etc/postgresql/13.3/main or /var/lib/pgsql/data), add the following lines and restart PostgreSQL -(sudo service postgresql restart):

    -
    local all postgres peer
    -local baselayer baselayer trust
    -local baselayer_test baselayer trust
    +(sudo service postgresql restart or systemctl reload postgresql):

    +
    # CONNECTION DATABASE USER ADDRESS METHOD
    +host template_app template_app localhost trust
    +host all postgres localhost trust
     
    +

    Substitute the correct database name and user, as defined in your config.yaml.

  • diff --git a/usage.html b/usage.html index 46118e0e..f726a802 100644 --- a/usage.html +++ b/usage.html @@ -1,22 +1,24 @@ - + - + Usage — baselayer vUndefined documentation - - - + + + + + - - - - - + + + + +