1
1
# HLS Nuremberg Trials Project
2
2
3
- > This is a Django client for the digital archives of the Nuremberg Trials
3
+ > This is a Django web site for the digital archives of the Nuremberg Trials
4
4
> Project maintained by the Harvard Law Library. It is intended as a
5
5
> open-access web app for scholars, researchers, and members of the public,
6
6
> exposing the digitized documents, full-text trial transcripts, and rich
@@ -28,7 +28,7 @@ To run with production settings, set appropriate `SECRET_KEY`,
28
28
` ALLOWED_HOSTS ` , and ` HOST_NAME ` env vars, and run:
29
29
30
30
``` shell
31
- docker compose -f docker-compose.yml -f docker-compose.prod.yml up -d
31
+ docker compose up -d
32
32
docker compose exec web python manage.py compress
33
33
docker compose exec web python manage.py collectstatic
34
34
```
@@ -39,7 +39,7 @@ Then visit [localhost:8080](http://localhost:8080).
39
39
When you are finished,
40
40
41
41
``` shell
42
- docker compose -f docker-compose.yml -f docker-compose.prod.yml down
42
+ docker compose down
43
43
```
44
44
45
45
## Project Structure
@@ -90,24 +90,11 @@ docker compose exec web pytest nuremberg/documents/browser_tests.py
90
90
91
91
## Project Settings
92
92
93
- > NOTE: An example configuration used for the demo site on Heroku is in the
94
- > [ heroku] ( https://github.com/harvard-lil/nuremberg/tree/heroku ) branch as
95
- > ` staging.py ` .
96
-
97
- Environment-specific Django settings live in the ` nuremberg ` /settings` directory
98
- and inherit from ` nuremberg.settings.generic ` . The settings module is configured
99
- by the ` DJANGO_SETTINGS_MODULE ` environment variable; the default value is
100
- ` nuremberg.settings.dev ` .
93
+ The Django settings live in the ` nuremberg/settings.py ` .
101
94
102
95
Secrets (usernames, passwords, security tokens, nonces, etc.) should not be
103
96
placed in a settings file or committed into git. The proper place for these is
104
- an environment variable configured on the host and read via ` os.environ ` . If
105
- they must live in a ` .py ` file, they should be included in the environment
106
- settings file via an ` import ` statement and uploaded separately as part of the
107
- deployment process.
108
-
109
- (The only exception to this is the defaults used in the dev environment.)
110
-
97
+ an environment variable configured on the host and read via ` os.environ ` .
111
98
112
99
## Data
113
100
@@ -242,12 +229,6 @@ deploying an updated schema, make sure you have generated and committed
242
229
new ` schema.xml ` and ` solrconfig.xml ` files using `manage.py build_solr_schema
243
230
--configure-dir=solr_conf`, and then run a complete reindexing.
244
231
245
- > WARNING: Be cautious when doing this in production-- although in general
246
- > reindexing will happen transparently and the site can continue to serve requests
247
- > while reindexing is in progress, certain schema changes will cause a
248
- > ` SCHEMA-INDEX-MISMATCH ` error that will cause search pages to crash until
249
- > reindexing completes.
250
-
251
232
252
233
## Transcripts
253
234
@@ -291,17 +272,3 @@ minor cosmetic features implemented in `search`.
291
272
292
273
In production, all site javascript is compacted into a single minified blob by
293
274
` compressor ` . (The exception is the rarely-needed dependency ` jsPDF ` .)
294
-
295
- ### In Production
296
-
297
- ** NOTE:*** This information is incorrect for the new upcoming production environment in Kubernetes!!!!
298
-
299
- When deploying, you should run ` docker compose exec web python manage.py compress ` to bundle, minify and
300
- compress CSS and JS files, and ` docker compose exec web python manage.py collectstatic ` to move the remaining
301
- assets into ` static/ ` . This folder should not be committed to git.
302
-
303
- For deployment to Heroku, these static files will be served by the WhiteNoise
304
- server. In other environments it may be appropriate to serve them directly with
305
- Nginx or Apache. If necessary, the output directory can be controlled with an
306
- environment-specific override of the ` STATIC_ROOT ` settings variable.
307
-
0 commit comments