altf4arnold/datatracker
1
0
Fork 0
Code Issues Pull requests Actions 3 Packages Projects Releases Wiki Activity

chore: add nginx reverse proxy to dev environment (#5745)

Browse source 
* chore: add nginx reverse proxy to dev environment

* chore: replace settings_local in docker and backup old
This commit is contained in:
Nicolas Giard 2023-06-05 17:47:06 -04:00 committed by GitHub
parent 4051ac8c85
commit 03a192b54c
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
10 changed files with 118 additions and 29 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

8
.devcontainer/devcontainer.json
View file

@ -66,7 +66,7 @@
}, },
// Use 'forwardPorts' to make a list of ports inside the container available locally. // Use 'forwardPorts' to make a list of ports inside the container available locally.
"forwardPorts": [3000, 5432, 5433, 8000, 8001], "forwardPorts": [3000, 5432, 5433, 8000],
"portsAttributes": { "portsAttributes": {
"3000": { "3000": {
@ -82,12 +82,12 @@
"onAutoForward": "silent" "onAutoForward": "silent"
}, },
"8000": { "8000": {
"label": "Datatracker", "label": "NGINX",
"onAutoForward": "notify" "onAutoForward": "notify"
}, },
"8001": { "8001": {
"label": "Static", "label": "Datatracker",
"onAutoForward": "silent" "onAutoForward": "ignore"
} }
}, },

3
.devcontainer/docker-compose.extend.yml
View file

@ -18,5 +18,8 @@ services:
pgadmin: pgadmin:
network_mode: service:db network_mode: service:db
static:
network_mode: service:db
volumes: volumes:
datatracker-vscode-ext: datatracker-vscode-ext:

6
.vscode/launch.json vendored
View file

@ -12,7 +12,7 @@
"program": "${workspaceFolder}/ietf/manage.py", "program": "${workspaceFolder}/ietf/manage.py",
"args": [ "args": [
"runserver", "runserver",
"0.0.0.0:8000", "0.0.0.0:8001",
"--settings=settings_local" "--settings=settings_local"
], ],
"django": true, "django": true,
@ -30,7 +30,7 @@
"program": "${workspaceFolder}/ietf/manage.py", "program": "${workspaceFolder}/ietf/manage.py",
"args": [ "args": [
"runserver", "runserver",
"0.0.0.0:8000", "0.0.0.0:8001",
"--settings=settings_local_vite" "--settings=settings_local_vite"
], ],
"django": true, "django": true,
@ -48,7 +48,7 @@
"program": "${workspaceFolder}/ietf/manage.py", "program": "${workspaceFolder}/ietf/manage.py",
"args": [ "args": [
"runserver", "runserver",
"0.0.0.0:8000", "0.0.0.0:8001",
"--settings=settings_local_debug" "--settings=settings_local_debug"
], ],
"django": true, "django": true,

2
docker-compose.yml
View file

@ -62,8 +62,6 @@ services:
static: static:
image: ghcr.io/ietf-tools/static:latest image: ghcr.io/ietf-tools/static:latest
restart: unless-stopped restart: unless-stopped
ports:
- 8001:80
mq: mq:
image: rabbitmq:3-alpine image: rabbitmq:3-alpine

7
docker/app.Dockerfile
View file

@ -30,6 +30,13 @@ COPY docker/scripts/app-setup-python.sh /tmp/library-scripts/docker-setup-python
RUN sed -i 's/\r$//' /tmp/library-scripts/docker-setup-python.sh && chmod +x /tmp/library-scripts/docker-setup-python.sh RUN sed -i 's/\r$//' /tmp/library-scripts/docker-setup-python.sh && chmod +x /tmp/library-scripts/docker-setup-python.sh
RUN bash /tmp/library-scripts/docker-setup-python.sh "none" "/usr/local" "${PIPX_HOME}" "${USERNAME}" RUN bash /tmp/library-scripts/docker-setup-python.sh "none" "/usr/local" "${PIPX_HOME}" "${USERNAME}"
# Setup nginx
COPY docker/scripts/app-setup-nginx.sh /tmp/library-scripts/docker-setup-nginx.sh
RUN sed -i 's/\r$//' /tmp/library-scripts/docker-setup-nginx.sh && chmod +x /tmp/library-scripts/docker-setup-nginx.sh
RUN bash /tmp/library-scripts/docker-setup-nginx.sh
COPY docker/configs/nginx-proxy.conf /etc/nginx/sites-available/default
COPY docker/configs/nginx-502.html /var/www/html/502.html
# Remove library scripts for final image # Remove library scripts for final image
RUN rm -rf /tmp/library-scripts RUN rm -rf /tmp/library-scripts

59
docker/configs/nginx-502.html Normal file
View file

@ -0,0 +1,59 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>Datatracker DEV</title>
<style>
body {
background-color: #111;
color: #FFF;
font-family: Arial, Helvetica, sans-serif;
text-align: center;
padding: 50px;
font-size: 16px;
}
img {
height: 80px;
}
h1 {
color: #CCC;
}
div {
background-color: #222;
border-radius: 10px;
padding: 10px 50px;
display: inline-block;
}
i {
font-size: 64px;
line-height: 16px;
vertical-align: text-bottom;
margin-right: 5px;
}
code {
background-color: #444;
padding: 3px 6px;
border-radius: 5px;
margin: 0 5px;
}
.mt {
margin-top: 15px;
}
a {
color: #31CCEC;
}
</style>
</head>
<body>
<img src="/_static/logos/ietf-inverted.svg" alt="IETF" />
<h1>Datatracker</h1>
<h2>Could not connect to dev server.</h2>
<div>
<p>Is the datatracker server running?</p>
<p class="mt">Using <strong>VS Code</strong>, open the <strong>Run and Debug</strong> tab on the left and click the <i>&#x2023;</i> symbol (Run Server) to start the server.</p>
<p>Otherwise, run the command <code>ietf/manage.py runserver 0.0.0.0:8001</code> from the terminal.</p>
</div>
<p class="mt">For more information, check out the <a href="https://github.com/ietf-tools/datatracker/blob/main/docker/README.md" target="_blank">Datatracker Development in Docker</a> guide.</p>
</body>
</html>

23
docker/configs/nginx-proxy.conf Normal file
View file

@ -0,0 +1,23 @@
server {
listen 8000 default_server;
listen [::]:8000 default_server;
root /var/www/html;
index index.html index.htm index.nginx-debian.html;
server_name _;
location /_static/ {
proxy_pass http://localhost:80/;
}
location / {
error_page 502 /502.html;
proxy_pass http://localhost:8001/;
}
location /502.html {
root /var/www/html;
internal;
}
}

2
docker/configs/settings_local.py
View file

@ -56,4 +56,4 @@ SLIDE_STAGING_PATH = 'test/staging/'
DE_GFM_BINARY = '/usr/local/bin/de-gfm' DE_GFM_BINARY = '/usr/local/bin/de-gfm'
STATIC_IETF_ORG = "http://localhost:8001" STATIC_IETF_ORG = "/_static"

33
docker/scripts/app-init.sh
View file

@ -21,6 +21,11 @@ sudo chown dev:dev "/assets"
echo "Fix chromedriver /dev/shm permissions..." echo "Fix chromedriver /dev/shm permissions..."
sudo chmod 1777 /dev/shm sudo chmod 1777 /dev/shm
# Run nginx
echo "Starting nginx..."
sudo nginx
# Build node packages that requrie native compilation # Build node packages that requrie native compilation
echo "Compiling native node packages..." echo "Compiling native node packages..."
yarn rebuild yarn rebuild
@ -35,37 +40,27 @@ cp $WORKSPACEDIR/docker/configs/settings_postgresqldb.py $WORKSPACEDIR/ietf/sett
if [ ! -f "$WORKSPACEDIR/ietf/settings_local.py" ]; then if [ ! -f "$WORKSPACEDIR/ietf/settings_local.py" ]; then
echo "Setting up a default settings_local.py ..." echo "Setting up a default settings_local.py ..."
cp $WORKSPACEDIR/docker/configs/settings_local.py $WORKSPACEDIR/ietf/settings_local.py
else else
echo "Using existing ietf/settings_local.py file" echo "Renaming existing ietf/settings_local.py to ietf/settings_local.py.bak"
if ! cmp -s $WORKSPACEDIR/docker/configs/settings_local.py $WORKSPACEDIR/ietf/settings_local.py; then mv -f $WORKSPACEDIR/ietf/settings_local.py $WORKSPACEDIR/ietf/settings_local.py.bak
echo "NOTE: Differences detected compared to docker/configs/settings_local.py!"
echo "We'll assume you made these deliberately."
fi
fi fi
cp $WORKSPACEDIR/docker/configs/settings_local.py $WORKSPACEDIR/ietf/settings_local.py
if [ ! -f "$WORKSPACEDIR/ietf/settings_local_debug.py" ]; then if [ ! -f "$WORKSPACEDIR/ietf/settings_local_debug.py" ]; then
echo "Setting up a default settings_local_debug.py ..." echo "Setting up a default settings_local_debug.py ..."
cp $WORKSPACEDIR/docker/configs/settings_local_debug.py $WORKSPACEDIR/ietf/settings_local_debug.py
else else
echo "Using existing ietf/settings_local_debug.py file" echo "Renaming existing ietf/settings_local_debug.py to ietf/settings_local_debug.py.bak"
if ! cmp -s $WORKSPACEDIR/docker/configs/settings_local_debug.py $WORKSPACEDIR/ietf/settings_local_debug.py; then mv -f $WORKSPACEDIR/ietf/settings_local.py $WORKSPACEDIR/ietf/settings_local.py.bak
echo "NOTE: Differences detected compared to docker/configs/settings_local_debug.py!"
echo "We'll assume you made these deliberately."
fi
fi fi
cp $WORKSPACEDIR/docker/configs/settings_local_debug.py $WORKSPACEDIR/ietf/settings_local_debug.py
if [ ! -f "$WORKSPACEDIR/ietf/settings_local_vite.py" ]; then if [ ! -f "$WORKSPACEDIR/ietf/settings_local_vite.py" ]; then
echo "Setting up a default settings_local_vite.py ..." echo "Setting up a default settings_local_vite.py ..."
cp $WORKSPACEDIR/docker/configs/settings_local_vite.py $WORKSPACEDIR/ietf/settings_local_vite.py
else else
echo "Using existing ietf/settings_local_vite.py file" echo "Renaming existing ietf/settings_local_vite.py to ietf/settings_local_vite.py.bak"
if ! cmp -s $WORKSPACEDIR/docker/configs/settings_local_vite.py $WORKSPACEDIR/ietf/settings_local_vite.py; then mv -f $WORKSPACEDIR/ietf/settings_local_vite.py $WORKSPACEDIR/ietf/settings_local_vite.py.bak
echo "NOTE: Differences detected compared to docker/configs/settings_local_vite.py!"
echo "We'll assume you made these deliberately."
fi
fi fi
cp $WORKSPACEDIR/docker/configs/settings_local_vite.py $WORKSPACEDIR/ietf/settings_local_vite.py
# Create data directories # Create data directories

4
docker/scripts/app-setup-nginx.sh Normal file
View file

@ -0,0 +1,4 @@
#!/usr/bin/env bash
apt-get update -y
apt-get install -y nginx