Last update:
- 2023-11-20
+ 2023-11-14
Wagtail Backend for Open Vault Redesign
"},{"location":"#reference","title":"Reference","text":"
Further details can be found in the reference section
"},{"location":"#other-resources","title":"Other Resources","text":"
This is one componenet of the Open Vault redesign. Others are:
ov-frontend Frontend ov-deploy Deployment resources "},{"location":"#credits","title":"Credits","text":"
Created by WGBH-MLA
"},{"location":"dev/","title":"Development","text":""},{"location":"dev/#ov","title":"
ov","text":"
The ov script is the primary Open Vault command line script. This contains a number of pre-built commands to do basic operations.
"},{"location":"dev/#usage","title":"Usage","text":"
ov COMMAND [args]
ov --help
COMMANDS:\n\n b | build build the docker images\n c | cmd run a compose command\n cover | coverage Run the test suite with coverage\n d | dev start a development server\n m | manage run a wagtail manage.py command\n s | shell run a django shell command with the app context\n t | test Run the test suite\n tui Run an interactive TUI\n"},{"location":"dev/#commands","title":"Commands","text":""},{"location":"dev/#b-build","title":"
b |
build","text":"Build the docker images locally.
Pass options to docker build
Additional docker arguments can be passed to this command.
For example, to force a rebuild of the images:
ov b --no-cache\n"},{"location":"dev/#c-cmd","title":"
c |
cmd","text":"Run a
docker compose command with the base config files in place."},{"location":"dev/#d-dev","title":"
d |
dev","text":"Run Development Environment Run the development environment, with
docker compose, and follow container logs.
Pass options to docker compose
Additional compose arguments can be passed. For example, to rebuild the containers before running:
ov d --build\n"},{"location":"dev/#m-manage","title":"
m |
manage","text":"Run a
manage.py command in the docker context."},{"location":"dev/#s-shell","title":"
s |
shell","text":"Enter into a python django shell interpreter, with the application context loaded."},{"location":"dev/#examples","title":"Examples","text":"
The following are some useful examples of development commands that might be run:
"},{"location":"dev/#migrate-database","title":"Migrate database","text":"
Generating the migration files can be accomplished with:
ov m makemigrations\nTo Run the database migrations:
ov m migrate\n"},{"location":"dev/#show-the-logs","title":"Show the logs","text":"
Show the docker compose logs
ov c logs\nShow logs for just the frontend
ov c logs ov-frontend\n"},{"location":"setup/","title":"Setup","text":""},{"location":"setup/#prerequisites","title":"Prerequisites","text":"
This page describes how to run the development environment. You can run the development environment locally, or in a docker container.
"},{"location":"setup/#local","title":"Local","text":"
This is the recommended way to run the development environment, for ease of use and speed. - python - pip - Running Postgres image
Use pip to install PDM, the package manager used for this project.
pip install pdm\nInstall the dependencies with PDM
pdm install\nYou can now run the ov command to interact with the development environment.
Help! How do I ... ?
For a full list of available commands, run
ov -h\nFor additional information, see the dev#ov section of the development documentation.
Activate virtual environment
If you are not already in a virtual environment, activate the one created by PDM.
$(pdm venv activate)\n"},{"location":"setup/#database","title":"Database","text":"
The development environment requires a running Postgres database. The easiest way to run this is with a docker container.
docker run --name ov-db -e POSTGRES_PASSWORD=\"YOUR POSTGRES PASSWORD HERE\" -p 5432:5432 -d postgres:alpine\n"},{"location":"setup/#docker","title":"Docker","text":"
The development environment can also be run in docker containers, which includes a database configuration. - docker compose installed
Requirements
Running the services outside of docker is possible, but not supported in this context.
"},{"location":"setup/#setup_1","title":"Setup","text":""},{"location":"setup/#0-clone-repository","title":"0. Clone repository","text":"Clone repository
git clone https://github.com/WGBH-MLA/ov-wag.git\n"},{"location":"setup/#1-create-the-backend-secrets-file","title":"1. Create the backend secrets file","text":"
In ov-wag, create a file called .env with the following contents:
ov-wag/.env
OV_DB_ENGINE=django.db.backends.postgresql\nOV_DB_PORT=5432\nOV_DB_NAME=ov\nOV_DB_USER=postgres\nOV_DB_PASSWORD=\"YOUR POSTGRES PASSWORD HERE\"\n\nOV_BASE_URL=http://localhost:3000\nOV_ADMIN_BASE_URL=http://localhost:8000\n"},{"location":"setup/#2-optional-build-the-backend","title":"2. (Optional) Build the backend","text":"
If you have local changes, you can build the backend image locally: Build the backend
ov b\n"},{"location":"setup/#3-start-the-backend","title":"3. Start the backend","text":"
Start the backend
ov d\n You can now visit the admin interface at http://localhost:8000/admin"},{"location":"setup/#4-create-a-superuser","title":"4. Create a superuser","text":"Create a superuser
ov m createsuperuser\nFollow the prompts to create an admin user.
"},{"location":"setup/#5-start-the-frontend","title":"5. Start the frontend","text":"
Add frontend setup instructions
Make this link work! ov-frontend setup
"},{"location":"reference/","title":"Reference","text":""},{"location":"reference/#api","title":"API","text":"
TODO: Add API docs
"}]}
\ No newline at end of file
+{"config":{"lang":["en"],"separator":"[\\s\\-]+","pipeline":["stopWordFilter"]},"docs":[{"location":"","title":"OV-Wag","text":"
Wagtail Backend for Open Vault Redesign
"},{"location":"#reference","title":"Reference","text":"
Further details can be found in the reference section
"},{"location":"#other-resources","title":"Other Resources","text":"
This is one componenet of the Open Vault redesign. Others are:
ov-frontend Frontend ov-deploy Deployment resources "},{"location":"#credits","title":"Credits","text":"
Created by WGBH-MLA
"},{"location":"reference/","title":"Reference","text":""}]}
\ No newline at end of file
diff --git a/0.4/setup/index.html b/0.4/setup/index.html
deleted file mode 100644
index 73ccb0e..0000000
--- a/0.4/setup/index.html
+++ /dev/null
@@ -1,747 +0,0 @@
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Setup - Open Vault: Wagtail
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-Setup
-Prerequisites
-This page describes how to run the development environment. You can run the development environment locally, or in a docker container.
-Local
-This is the recommended way to run the development environment, for ease of use and speed.
-- python
-- pip
-- Running Postgres image
-Use pip to install PDM , the package manager used for this project.
-
-Install the dependencies with PDM
-
-You can now run the ov command to interact with the development environment.
-
-Help! How do I ... ?
-For a full list of available commands, run
-
-For additional information, see the dev#ov section of the development documentation.
-
-
-Activate virtual environment
-If you are not already in a virtual environment, activate the one created by PDM.
-
-
-Database
-The development environment requires a running Postgres database. The easiest way to run this is with a docker container.
-docker run --name ov-db -e POSTGRES_PASSWORD = "YOUR POSTGRES PASSWORD HERE" -p 5432 :5432 -d postgres:alpine
-Docker
-The development environment can also be run in docker containers, which includes a database configuration.
-- docker compose installed
-
-Requirements
-
-Running the services outside of docker is possible, but not supported in this context.
-
-Setup
-0. Clone repository
-Clone repository git clone https://github.com/WGBH-MLA/ov-wag.git
-1. Create the backend secrets file
-In ov-wag, create a file called .env with the following contents:
-ov-wag/.env OV_DB_ENGINE = django.db.backends.postgresql
-OV_DB_PORT = 5432
-OV_DB_NAME = ov
-OV_DB_USER = postgres
-OV_DB_PASSWORD = "YOUR POSTGRES PASSWORD HERE"
-
-OV_BASE_URL = http://localhost:3000
-OV_ADMIN_BASE_URL = http://localhost:8000
-2. (Optional) Build the backend
-If you have local changes, you can build the backend image locally:
-
-3. Start the backend
-
-You can now visit the admin interface at http://localhost:8000/admin
-4. Create a superuser
-Create a superuser ov m createsuperuser
-Follow the prompts to create an admin user.
-5. Start the frontend
-
-
-
-
-
- Last update:
- 2023-11-20
-
- 2023-11-20
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
\ No newline at end of file
diff --git a/0.4/sitemap.xml b/0.4/sitemap.xml
index fdbffac..a1eff41 100644
--- a/0.4/sitemap.xml
+++ b/0.4/sitemap.xml
@@ -2,22 +2,12 @@
https://wgbh-mla.github.io/ov-wag/0.4/
- 2023-11-21
- daily
-
-
- https://wgbh-mla.github.io/ov-wag/0.4/dev/
- 2023-11-21
- daily
-
-
- https://wgbh-mla.github.io/ov-wag/0.4/setup/
- 2023-11-21
+ 2023-11-30
daily
https://wgbh-mla.github.io/ov-wag/0.4/reference/
- 2023-11-21
+ 2023-11-30
daily
\ No newline at end of file
diff --git a/0.4/sitemap.xml.gz b/0.4/sitemap.xml.gz
index 72ffdd2..c697972 100644
Binary files a/0.4/sitemap.xml.gz and b/0.4/sitemap.xml.gz differ
diff --git a/0.4/style/cmd.css b/0.4/style/cmd.css
deleted file mode 100644
index 2222c0e..0000000
--- a/0.4/style/cmd.css
+++ /dev/null
@@ -1,17 +0,0 @@
-:root {
- --md-admonition-icon--cmd: url('data:image/svg+xml;charset=utf-8,
');
- }
- .md-typeset .admonition.cmd,
- .md-typeset details.cmd {
- border-color: rgb(0, 191, 165);
- }
- .md-typeset .cmd > .admonition-title,
- .md-typeset .cmd > summary {
- background-color: rgba(0, 191, 165, 0.1);
- }
- .md-typeset .cmd > .admonition-title::before,
- .md-typeset .cmd > summary::before {
- background-color: rgb(0, 191, 165);
- -webkit-mask-image: var(--md-admonition-icon--cmd);
- mask-image: var(--md-admonition-icon--cmd);
- }