Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jpbruinsslot/docker-django
A project to get you started with Docker and Django.
https://github.com/jpbruinsslot/docker-django
django docker nginx postgresql uwsgi
Last synced: 2 months ago
JSON representation
A project to get you started with Docker and Django.
- Host: GitHub
- URL: https://github.com/jpbruinsslot/docker-django
- Owner: jpbruinsslot
- License: mit
- Archived: true
- Created: 2015-01-29T14:12:50.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2018-12-15T10:58:21.000Z (about 6 years ago)
- Last Synced: 2024-08-02T07:02:19.616Z (5 months ago)
- Topics: django, docker, nginx, postgresql, uwsgi
- Language: Python
- Size: 875 KB
- Stars: 179
- Watchers: 12
- Forks: 62
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Docker Django
=============
## tl;dr
```bash
$ git clone [email protected]:erroneousboat/docker-django.git
$ docker-compose up
```
Now you can access the application at and the admin site
at .
A project to get you started with Docker and Django. This is made to
serve as an example for you to hack on, so I don't claim that this is the
correct way to setup a system with Django and Docker. Thus, I advice to also
look at other projects.
Stack and version numbers used:
| Name | Version |
|----------------|----------|
| Django | 2.1.4 |
| Nginx | 1.15 |
| Postgresql | 11.1 |
| uWSGI | 2.0.17.1 |
## Folder structure
```
$ tree -L 1 --dirsfirst
.
├── config # files needed for configuration
├── webapp # actual webapp
├── docker-compose.yml # docker-compose setup with container orchestration instructions
├── LICENSE # license for this project
└── README.md # this file
```
## Setting up
### Docker
See installation instructions at: [docker documentation](https://docs.docker.com/install/)
### Docker Compose
Install [docker compose](https://github.com/docker/compose), see installation
instructions at [https://docs.docker.com/compose/install/](https://docs.docker.com/compose/install/)
### Django
Create django project in the `webapp` folder or copy a project to the `webapp`
folder or use the sample project enclosed in this project and go directly to
the section 'Fire it up':
```bash
# Be sure you have Django installed on your system
$ django-admin startproject
```
Edit `config/environment/development.env` file and add the name of your
project at `DJANGO_PROJECT_NAME` or just leave it as is to start the default
application.
Edit the `settings.py` file with the correct database credentials and static
root:
```python
DATABASES = {
'default': {
'ENGINE': 'django.db.backends.postgresql_psycopg2',
'NAME': os.environ.get('POSTGRES_NAME'),
'USER': os.environ.get('POSTGRES_USER'),
'PASSWORD': os.environ.get('POSTGRES_PASSWORD'),
'HOST': os.environ.get('POSTGRES_HOST'),
'PORT': os.environ.get('POSTGRES_PORT'),
}
}
STATIC_ROOT = '/srv/static-files'
```
### Environment variables
The file `config/environment/development.env` contains the environment
variables needed in the containers. You can edit this as you see fit, and at
the moment these are the defaults that this project uses. However when you
intend to use this, keep in mind that you should keep this file out of version
control as it can hold sensitive information regarding your project. The file
itself will contain some commentary on how a variable will be used in the
container.
## Fire it up
Start the container by issuing one of the following commands:
```bash
$ docker-compose up # run in foreground
$ docker-compose up -d # run in background
```
## Other commands
Build images:
```bash
$ docker-compose build
$ docker-compose build --no-cache # build without cache
```
See processes:
```bash
$ docker-compose ps # docker-compose processes
$ docker ps -a # docker processes (sometimes needed)
$ docker stats [container name] # see live docker container metrics
```
See logs:
```bash
# See logs of all services
$ docker-compose logs
# See logs of a specific service
$ docker-compose logs -f [service_name]
```
Run commands in container:
```bash
# Name of service is the name you gave it in the docker-compose.yml
$ docker-compose run [service_name] /bin/bash
$ docker-compose run [service_name] python /srv/starter/manage.py shell
$ docker-compose run [service_name] env
```
Remove all docker containers:
```bash
docker rm $(docker ps -a -q)
```
Remove all docker images:
```bash
docker rmi $(docker images -q)
```
### Some commands for managing the webapp
To initiate a command in an existing running container use the `docker exec`
command.
```bash
# Find container_name by using docker-compose ps
# restart uwsgi in a running container.
$ docker exec [container_name] touch /etc/uwsgi/reload-uwsgi.ini
# create migration file for an app
$ docker exec -it [container-name] \
python /srv/[project-name]/manage.py makemigrations scheduler
# migrate
$ docker exec -it [container-name] \
python3 /srv/[project-name]/manage.py migrate
# get sql contents of a migration
$ docker exec -it [container-name] \
python3 /srv/[project-name]/manage.py sqlmigrate [appname] 0001
# get to interactive console
$ docker exec -it [container-name] \
python3 /srv/[project-name]/manage.py shell
# testing
docker exec [container-name] \
python3 /srv/[project-name]/manage.py test
```
## Troubleshooting
Q: I get the following error message when using the docker command:
```
FATA[0000] Get http:///var/run/docker.sock/v1.16/containers/json: dial unix /var/run/docker.sock: permission denied. Are you trying to connect to a TLS-enabled daemon without TLS?
```
A: Add yourself (user) to the docker group, remember to re-log after!
```bash
$ usermod -a -G docker
$ service docker restart
```
Q: Changes in my code are not being updated despite using volumes.
A: Remember to restart uWSGI for the changes to take effect.
```bash
# Find container_name by using docker-compose ps
$ docker exec [container_name] touch /etc/uwsgi/reload-uwsgi.ini
```