Compare commits

..

No commits in common. "nginx-unit" and "master" have entirely different histories.

15 changed files with 236 additions and 167 deletions

3
.gitignore vendored
View File

@ -3,8 +3,7 @@ settings.json
db.sqlite3
dummyusers.json
*.prof
statictest.txt
./test.sh
# IDE
.vscode

View File

@ -23,10 +23,9 @@ with open(BASE_DIR + "/settings.json", "r") as userfile:
CALIBRE_DIR = os.path.abspath(usersettings["CALIBRE_DIR"])
SECRET_KEY = usersettings["SECRET_KEY"]
ALLOWED_HOSTS = usersettings["ALLOWED_HOSTS"]
INTERNAL_IPS = usersettings["INTERNAL_IPS"]
DEBUG = usersettings["DEBUG"]
DOCKER = os.environ.get('AM_DOCKER_INSTANCE', False)
# Build paths inside the project like this: os.path.join(BASE_DIR, ...)
@ -65,41 +64,38 @@ STATIC_ROOT = BASE_DIR + "/static/"
#########################################################################
# LOGGING
# TODO: think about the issue for a bit. no write access to file on first run
# but startscript doesn't run to give access if it can't start django
# if not DOCKER:
# logfile = "/app//data//django.log"
# if not os.path.isfile(logfile):
# os.mknod(logfile)
# LOGGING = {
# "version": 1,
# "disable_existing_loggers": False,
# "root": {"level": "INFO", "handlers": ["file"]},
# "handlers": {
# "file": {
# "level": "INFO",
# "class": "logging.FileHandler",
# "filename": logfile,
# "formatter": "app",
# },
# },
# "loggers": {
# "django": {
# "handlers": ["file"],
# "level": "INFO",
# "propagate": True
# },
# },
# "formatters": {
# "app": {
# "format": (
# u"%(asctime)s [%(levelname)-8s] "
# "(%(module)s.%(funcName)s) %(message)s"
# ),
# "datefmt": "%Y-%m-%d %H:%M:%S",
# },
# },
# }
logfile = usersettings["LOGFOLDER"] + "django.log"
LOGGING = {
"version": 1,
"disable_existing_loggers": False,
"root": {"level": "INFO", "handlers": ["file"]},
"handlers": {
"file": {
"level": "INFO",
"class": "logging.FileHandler",
"filename": logfile,
"formatter": "app",
},
},
"loggers": {
"django": {
"handlers": ["file"],
"level": "INFO",
"propagate": True
},
},
"formatters": {
"app": {
"format": (
u"%(asctime)s [%(levelname)-8s] "
"(%(module)s.%(funcName)s) %(message)s"
),
"datefmt": "%Y-%m-%d %H:%M:%S",
},
},
}
## ##
@ -144,7 +140,6 @@ INSTALLED_APPS = [
'django.contrib.messages',
'django.contrib.staticfiles',
"library",
"django_extensions"
# "silk", # DEBUG/profilling purposes
# 'debug_toolbar', # DEBUG purposes
]
@ -194,23 +189,19 @@ WSGI_APPLICATION = 'CalibreWebCompanion.wsgi.application'
## DATBASE ##
# https://docs.djangoproject.com/en/3.0/ref/settings/#databases
if DOCKER:
djangodb_path = "/app/CalibreWebCompanion"
calibredb_path = "/app/content/"
if usersettings["ISDOCKER"]:
defaultdb_path = "/usr/src/app/data/"
else:
djangodb_path = BASE_DIR
calibredb_path = CALIBRE_DIR
defaultdb_path = BASE_DIR
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.sqlite3',
'NAME': os.path.join(djangodb_path, 'db.sqlite3'),
'NAME': os.path.join(defaultdb_path, 'db.sqlite3'),
},
'calibre': {
'ENGINE': 'django.db.backends.sqlite3',
'NAME': os.path.join(calibredb_path, 'metadata.db'),
'NAME': os.path.join(CALIBRE_DIR, 'metadata.db'),
}
}

View File

@ -0,0 +1,33 @@
import multiprocessing
import os
import json
bind = "127.0.0.1:8000"
workers = multiprocessing.cpu_count() * 2 + 1
preload_app = True # By preloading an application you can save some RAM resources as well as speed up server boot times
keepalive = 5
# daemon = True # Detaches the server from the controlling terminal and enters the background. disabled for now
# logging
with open("settings.json", "r") as jfile:
settings = json.load(jfile)
errorlog = settings["LOGFOLDER"] + "/gunicorn_error.log"
loglevel = "warning"
accesslog = settings["LOGFOLDER"] + "/gunicorn_access.log"
if not os.path.isdir("/usr/src/app/data/logs"):
os.mkdir("/usr/src/app/data/logs")
if not os.path.isfile(errorlog):
os.system('touch {}'.format(errorlog))
if not os.path.isfile(accesslog):
os.system('touch {}'.format(accesslog))
capture_output = True
# debug settings which need to be commented out in prod
# reload=True
# reload_engine = "inotify"
# I only went till the section https://docs.gunicorn.org/en/latest/settings.html#logging there are more settings
# some of them might be useful

View File

@ -6,7 +6,7 @@
<div class="col s12 m7">
<div class="card z-depth-0 horizontal">
<div class="card-image">
<a style="padding-top:15%" href=" /content/{{download}}"><img src=" /content/{{imgpath}}"
<a style="padding-top:15%" href=" /download/{{download}}"><img src=" /download/{{imgpath}}"
alt="download" srcset=""></a>
</div>
<div class="card-stacked">

View File

@ -1,13 +1,15 @@
{
"CALIBRE_DIR": "/app/content",
"LOGFOLDER" : "/usr/src/app/data/logs/",
"CALIBRE_DIR": "/usr/src/app/calibredir",
"SECRET_KEY": "u(8^+rb%rz5hsx4v^^y(ul7g(4n7a8!db@s*9(m5cs*2_ppy8+",
"ALLOWED_HOSTS": [
"*"
"127.0.0.1"
],
"INTERNAL_IPS": [
"127.0.0.1", "localhost"
"127.0.0.1"
],
"DEBUG" : false
"DEBUG" : true,
"LOGFOLDER" : "/usr/src/app/data/logs/",
"ISDOCKER" : true
}

View File

@ -1,23 +1,29 @@
## pull official base image
FROM nginx/unit:1.22.0-python3.9
EXPOSE 80
ENV AM_DOCKER_INSTANCE Yes
FROM python:3.8.3-alpine
EXPOSE 8080
## set work directory
WORKDIR /app
WORKDIR /usr/src/app
## install dependencies
RUN pip install --upgrade pip
COPY ./requirements.txt .
RUN pip install -r requirements.txt
RUN apk add nginx supervisor
# do nginx stuff
RUN adduser -D -g 'www' www
RUN mkdir -p /run/nginx
COPY ./deployment/nginx.conf /etc/nginx/
## copy project
COPY ./CalibreWebCompanion ./CalibreWebCompanion
copy ./deployment/startupscript.py ./
## gunicorn borks started with supervisord
COPY ./deployment/supervisord.conf /etc/
ENTRYPOINT /usr/bin/supervisord -c /etc/supervisord.conf
# perms
RUN chown -R unit:unit /app
COPY ./deployment/entrypoints/* /docker-entrypoint.d/
RUN chmod +x /docker-entrypoint.d/start.sh
# docker run --publish 80:80 \
# -v '/home/MassiveAtoms/Desktop/logs:/app/data' \
# -v '/home/MassiveAtoms/windows/Users/MassiveAtoms/Documents/Calibre Library/:/app/calibredir' \
# --name cw calibreweb:1.0
# docker run --publish 8000:80 \
# -v '/home/massiveatoms/Desktop/logs:/usr/src/app/data' \
# -v '/run/media/massiveatoms/1AEEEA6EEEEA421D1/Documents and Settings/MassiveAtoms/Documents/Calibre Library/:/usr/src/app/calibredir' \
# --name cw calibreweb:1.0.1

4
deployment/deploy.py Normal file
View File

@ -0,0 +1,4 @@
from os import environ

View File

@ -1,54 +0,0 @@
{
"listeners": {
"*:80": {
"pass": "routes"
}
},
"routes": [
{
"match": {
"uri": [
"/content/*",
"!~\\.db"
]
},
"action": {
"share": "/app/"
}
},
{
"match": {
"uri": "/static/*"
},
"action": {
"share": "/app/CalibreWebCompanion/"
}
},
{
"match": {
"uri": [
"!~\\.db", "*"
]
},
"action": {
"pass": "applications/django"
}
}
],
"applications": {
"django": {
"type": "python 3",
"path": "/app/CalibreWebCompanion/",
"module": "CalibreWebCompanion.wsgi",
"environment": {
"DJANGO_SETTINGS_MODULE": "CalibreWebCompanion.settings",
"DB_ENGINE": "django.db.backends.sqlite3"
},
"processes" : {
"max": 25,
"spare": 1,
"idle_timeout": 20
}
}
}
}

View File

@ -1,22 +0,0 @@
CAL_DIR="/app/content/"
DATA_DIR="/app/data/"
CWC_PATH="/app/CalibreWebCompanion"
if [ ! -d "$CAL_DIR" ]; then
echo "Calibre Library not mounted at the correct location."
echo "Mount it at /app/content/"
echo "Exiting..."
exit 1
fi
if [ ! -d "$DATA_DIR" ]; then
echo "A data directory not mounted at the correct location, exiting"
echo "This is used to store the database and logs"
echo "mount something at /app/data/"
echo "exiting"
exit 1
fi
cp -R -u -p "/app/CalibreWebCompanion/db.sqlite3" "/app/data/"
ls -l /app
python "${CWC_PATH}/manage.py" makemigrations
python "${CWC_PATH}/manage.py" migrate

View File

@ -7,13 +7,13 @@
5. run your container with your bind/mount your volumes/paths/things
Here's an example of step 5
```
docker run --publish 80:80 \
-v '/home/MassiveAtoms/Desktop/logs:/app/data' \
-v '/home/MassiveAtoms/windows/Users/MassiveAtoms/Documents/Calibre\ Library/:/app/calibredir' \
--name cw calibreweb:1.0
docker run --publish 80:80\
-v '/home/massiveatoms/Desktop/logs:/usr/src/app/data' \
-v '/run/media/massiveatoms/1AEEEA6EEEEA421D/Documents and Settings/MassiveAtoms/Documents/Calibre Library/:/usr/src/app/calibredir' \
--name cw calibreweb:1.0.1
```
your Calibre path/volume/whatever needs to be mounted at `/app/calibredir`, and you need to mount a volume for the db and logs at `/app/data`
your Calibre path/volume/whatever needs to be mounted at `/usr/src/app/calibredir`, and you need to mount a volume for the db and logs at `/usr/src/app/data`
Issues with it at the moment:
1. we still need to do something to create a random secret key. Atm, this would still

81
deployment/nginx.conf Normal file
View File

@ -0,0 +1,81 @@
worker_processes 1;
# user nobody nogroup;
user www www; # TEMP disabled
# user nobody nobody; # for systems with 'nobody' as a group instead
error_log /usr/src/app/data/logs/nginx.log warn;
# pid /var/run/nginx.pid;
events {
worker_connections 1024; # increase if you have lots of clients
accept_mutex off; # set to 'on' if nginx worker_processes > 1
use epoll; # to enable for Linux 2.6+ MASSIVEATOMS
# 'use kqueue;' to enable for FreeBSD, OSX
}
http {
include mime.types;
# fallback in case we can't determine a type
default_type application/octet-stream;
access_log /var/log/nginx/access.log combined;
sendfile on;
upstream app_server {
# fail_timeout=0 means we always retry an upstream even if it failed
# to return a good HTTP response
# for UNIX domain socket setups
# server unix:/tmp/gunicorn.sock fail_timeout=0;
# for a TCP configuration
server 127.0.0.1:8000 fail_timeout=0;
}
server {
# if no Host match, close the connection to prevent host spoofing
listen 80 default_server;
return 444;
}
server {
listen 80 deferred; # for Linux massiveatoms
# use 'listen 80 accept_filter=httpready;' for FreeBSD
# listen 80;
client_max_body_size 4G;
# set the correct host(s) for your site
server_name localhost 0.0.0.0; # set this to the server url? or ip? we'll see MASSIVEATOMS
keepalive_timeout 5;
# # MASSIVEATOMS
location /download/ {
alias "/usr/src/app/calibredir/";
# Never forget the fact that this little statement being root instead of alias caused us to lose more than a day troubleshooting
}
location /static/ {
alias "/usr/src/app/CalibreWebCompanion/static/";
# Never forget the fact that this little statement being root instead of alias caused us to lose more than a day troubleshooting
}
location / {
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
proxy_set_header X-Forwarded-Proto $scheme;
# proxy_set_header Host $http_host;
# we don't want nginx trying to do something clever with
# redirects, we set the Host: header above already.
proxy_redirect off;
proxy_pass http://127.0.0.1:8000;
}
error_page 500 502 503 504 /500.html;
location = /500.html {
root /path/to/app/current/public;
}
}
}

View File

@ -0,0 +1,11 @@
from os import system, chdir
# system("chown -R www:www /usr/src/app/calibredir")
# print("ownership of calibredir changed")
chdir("/usr/src/app/CalibreWebCompanion")
system("python ./manage.py makemigrations")
print("ran makemigrations")
system("python ./manage.py migrate")
print("migrate")

View File

@ -0,0 +1,36 @@
[supervisord]
nodaemon=true
logfile=/tmp/supervisord.log
childlogdir=/tmp
pidfile = /tmp/supervisord.pid
[program:gunicorn]
directory=/usr/src/app/CalibreWebCompanion
command=gunicorn CalibreWebCompanion.wsgi
stdout_logfile=/dev/stdout
stdout_logfile_maxbytes=0
stderr_logfile=/dev/stderr
stderr_logfile_maxbytes=0
autorestart=false
startretries=0
startsecs = 0
[program:nginx]
# user=www
command=nginx
stdout_logfile=/dev/stdout
stdout_logfile_maxbytes=0
stderr_logfile=/dev/stderr
stderr_logfile_maxbytes=0
autorestart=false
startretries=0
[program:startupscript]
directory=/usr/src/app
command=python ./startupscript.py
stdout_logfile=/dev/stdout
stdout_logfile_maxbytes=0
stderr_logfile=/dev/stderr
stderr_logfile_maxbytes=0
autorestart=false
startretries=0

View File

@ -1,7 +1,6 @@
django>=3.0.8
inotify>=0.2.10
gunicorn>=20.0
django-extensions
# development
# django-debug-toolbar>=2.2
# django-silk>=4.0

17
test.sh
View File

@ -1,17 +0,0 @@
docker build --tag calibreweb:1.0 . -f ./deployment/Dockerfile
docker stop cw
docker rm cw
docker run --publish 80:80 \
-v '/home/MassiveAtoms/Desktop/logs:/app/data' \
-v '/home/MassiveAtoms/windows/Users/MassiveAtoms/Documents/Calibre Library/:/app/content' \
--name cw calibreweb:1.0
sleep 8
echo "download/test"
curl -s -o /dev/null -w "%{http_code}" http://127.0.0.1/download/statictest.txt
echo " "
echo "/test"
curl -s -o /dev/null -w "%{http_code}" http://127.0.0.1/statictest.txt
echo " "
echo "/static/test"
curl -s -o /dev/null -w "%{http_code}" http://127.0.0.1/static/statictest.txt
echo " "