Skip to content

Commit 5568c51

Browse files
authored
Avoid mentioning specific version in deployment docs and list VUE_APP_* env vars (#1226)
1 parent 112f5c6 commit 5568c51

File tree

2 files changed

+12
-2
lines changed

2 files changed

+12
-2
lines changed

pydatalab/docs/config.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -16,6 +16,14 @@ administration"](deployment.md).
1616
- These can be provided as environment variables or in a `.env` file in the directory from which `pydatalab` is launched.
1717
3. Web app configuration, such as the URL of the relevant *datalab* API and branding (logo URLs, external homepage links).
1818
- These are typically provided as a `.env` file in the directory from which the webapp is built/served.
19+
- The main options include (a full list can be found in the `docker-compose.yml` file):
20+
- `VUE_APP_API_URL`: the URL of the *datalab* API, which is used by the web app to communicate with the server.
21+
- `VUE_APP_LOGO_URL`: the URL of an image to use as the logo header in the web app.
22+
- `VUE_APP_HOMEPAGE_URL`: a URL to provide as a link from the web app header.
23+
- `VUE_APP_EDITABLE_INVENTORY`: whether the inventory can be edited by non-admin users in the web app.
24+
- `VUE_APP_WEBSITE_TITLE`: the title of the web app, which is displayed in the browser tab and header.
25+
- `VUE_APP_QR_CODE_RESOLVER_URL`: the URL of a service that can resolve QR codes to *datalab* entries, which is used by the web app to display QR codes for entries (see [datalab-org/datalab-purl](https://github.com/datalab-org/datalab-purl) for more information).
26+
- `VUE_APP_AUTOMATICALLY_GENERATE_ID_DEFAULT`: whether to automatically generate IDs for new entries in the web app by default, or require a checkbox to be ticked at item creation.
1927

2028
## Mandatory settings
2129

pydatalab/docs/deployment.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,9 @@ Some things to consider:
5252
- Typically you will need to run the app and API on two different subdomains.
5353

5454
These can be provided perhaps by an IT department, or by configuring DNS settings on your own domain to point to the server.
55-
You will need to configure the app such so that it points at the relevant hosted API (see [app `.env` description](config.md#app).
55+
56+
You will need to configure the app such so that it points at the relevant hosted API (see [app `.env` description](config.md#app)), via the `VUE_APP_API_URL` variable.
57+
You can also control other options via several `VUE_APP_*` environment variables listed at the link above.
5658

5759
There will inevitably be specific infrastructure configuration required for your
5860
instance, for example, the mounting of disks into the API container to allow for
@@ -77,7 +79,7 @@ The process may look something like the following:
7779
- Add *datalab* as a [Git submodule](https://git-scm.com/book/en/v2/Git-Tools-Submodules):
7880
```shell
7981
git submodule add [email protected]:datalab-org/datalab
80-
cd datalab; git checkout v0.4.0 # at this point you can set any default version, or just track the main branch
82+
cd datalab; git checkout <commit_or_tag>; cd .. # at this point you can set any tagged version, or just track the main branch
8183
git commit -a -m "Add datalab as submodule"
8284
```
8385

0 commit comments

Comments
 (0)