A portfolio page for Matt McCarthy, a Web and mobile development contractor.
Make sure python3
and pip3
are installed on your system and install virtualenv
.
$ sudo apt install -y python3 python3-pip && pip3 install virtualenv
virtualenv
's default installation directory is $HOME/.local/bin
. Add it to your PATH
if it is not already there.
$ echo "export PATH=$PATH:$HOME/.local/bin" >> ~/.bashrc && source ~/.bashrc
In the project's root directory, run the following to create a new virtual environment.
$ virtualenv -p python3 env
Activate the newly created environment.
$ source env/bin/activate
At any point within the virtual environment, run deactivate
to deactivate.
(env) $ deactivate
Go back to the virtual environment and install project dependencies.
(env) $ pip install -r requirements.txt
Generate a secret key and pipe the output to a file. Change the newly created file's permissions to rw-------
, or 600
. Note that you will need to add the file to .gitignore
if you name it something other than secret.txt
(or change the directory in which it is located, or both) and choose to keep it in the repository. If you save the file somewhere other than BASE_DIR/auth
and/or name the file something other than secret.txt
, change the value of SECRET_KEY_FILE
in mwd/settings.py
to match your system's directory structure.
$ mkdir auth
$ python generate_secret_key.py > auth/secret.txt
$ sudo chmod 600 auth/secret.txt
Alternatively, export it as an environment variable and edit mwd/settings.py
to read the string that way.
$ export SECRET_KEY=$(python generate_secret_key.py)
In settings.py
, change
SECRET_KEY_FILE = '%s/auth/secret.txt' % BASE_DIR
with open(SECRET_KEY_FILE, 'r', encoding='utf8') as f:
content = f.readline()
SECRET_KEY = content[:-1]
to
SECRET_KEY = os.environ.get('SECRET_KEY')
No method is more secure than the other as an attacker can access the key both ways if they gain access to the system running the project.
Make and apply migrations.
(env) $ python manage.py makemigrations
(env) $ python manage.py migrate
To run in development mode, activate the virtual environment and execute the following:
(env) $ python manage.py runserver localhost:8000
To run in production mode, follow these steps after choosing your Linux distribution.