Simple Personal Site

A fast and minimalist Django-based CMS for developers and tech enthusiasts.

Table of Contents

• Features
• Before installing
• Installation
  • Install with Docker
  • Install in a virtualenv
• Using HTTPS
• Add content
• License

Features

• Easy-to-manage site content
• Markdown support throughout the site
• Post blog articles
• Create project cards
• Embed code blocks in blog posts
• Video and image embed in blog articles and project cards
• Show social media links in footer
• Contact form
• Host PGP public key
• URL shortener

Before installing

• Clone this project and enter project directory.

git clone https://github.com/chrisx8/simple-personal-site.git
cd simple-personal-site

• Generate a strong password here for database. Save it, as you'll need it during the setup process.
• Create your env file for site config.

cp .env.example .env

• Edit .env, following instructions in the file.
• Generate your own icons here. Download the generated Favicon package.
• Unzip the downloaded package and upload everything to static/img/, replacing ALL existing placeholder icon files.
• Upload a banner image for og:image (1280*640, in .png format) to static/img/, replacing the existing og-image.png

Installation

Install with Docker

Note: chrisx8/simple-personal-site on Docker Hub has been REMOVED. Please switch to ghcr.io/chrisx8/simple-personal-site.

• Make sure your database is accessible from inside the container
• Create directory for static files

mkdir -p static_serve/media staic_serve/static
sudo chown -R nobody:nogroup static_serve

• Run Docker container.

# Replace [ADDRESS]:[PORT] with whereever you want the container to listen at
# When using a reverse proxy, make sure this container is NOT EXPOSED to the
# Internet! (e.g. listen on 127.0.0.1)
docker run -d -p [ADDRESS]:[PORT] \
  --env-file=.env \
  -v $(pwd)/static_serve:/app/static_serve \
  -v $(pwd)/static:/app/static/ \
  --restart unless-stopped \
  --name simple-personal-site \
  ghcr.io/chrisx8/simple-personal-site:latest

• Create an admin account.

docker exec -it simple-personal-site python3 manage.py createsuperuser

• Set up a web server (such as Apache or Nginx) to serve static files.
  • Serve static_serve/media at /media/
  • Serve static_serve/static at /static/
  • DO NOT serve static/
  • Sample Nginx config

Install in a virtualenv

• This site only supports Python 3.9 or newer.
• Make sure Python (3.9 or newer) and pip are installed.
• Install project dependencies.

# Create virtualenv
python3 -m venv venv

# Activate virtualenv and install dependencies
source venv/bin/activate
pip install -r requirements.txt

• Start server

# Replace [ADDRESS]:[PORT] with whereever you want the container to listen at
# When using a reverse proxy, make sure this container is NOT EXPOSED to the
# Internet! (e.g. listen on 127.0.0.1)
gunicorn simple_personal_site.wsgi:application -b [ADDRESS]:[PORT]

• Create an admin account.

python3 manage.py createsuperuser

• Set up a web server (such as Apache or Nginx) to serve static files
  • Serve static_serve/media at /media/
  • Serve static_serve/static at /static/
  • DO NOT serve static/
  • Sample Nginx config

Using HTTPS

Using HTTPS is optional but highly recommended. To use HTTPS:

• Set up the site behind a reverse proxy. Sample Nginx config
• For best security, make sure the reverse proxy strips incoming X-Forwarded-Proto header, and sets X-Forwarded-Proto header to https for HTTPS connections only.
• Get an SSL certificate. Let's Encrypt offers free certificates to everyone.
• In .env, set USE_SSL=True.

Add content

Access the site and follow the guides on the Welcome page.

Congratulations! Now you have your personal site!

License

MIT License

Copyright (C) 2018-2023 Chris Xiao

---

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA256

NOTE: Commits signed with GPG key ID F6C6CFB7122581AE are valid.
-----BEGIN PGP SIGNATURE-----

iQIzBAEBCAAdFiEEFey6cJpFXZjlcujmvbyRm4D4r30FAl5MdeQACgkQvbyRm4D4
r33noA/+MSzY5Ow76vOHp3D1G3hiv7S7iMetVytuEfOzQI/nXZ9qINBm5Njb4xiI
MrDtOpisMDOv0A8cizqUbe38ljU2aK9nGBAhB072mjWWE0d6EFMz7Tx0lK7lRzD6
1fqk4S+Nr0UYIKDdj3rSPwn9jbwg8OQXf1XhWbGyQ9kU3zoKyl8ZHCxP5F1SiuiX
53IcaE7aB/kvdPetbU59rbZBkWNjVsf73AaClNccU+malZwURyS3Xb2RFTUpFIc5
O/wkGi2d/doj/tSkBsWylh4IGnYT+a0A0WremkHmnYUCmN5mJP7DfqHGfRhRw4rG
/DV6ocr9ayF1emdQOOUwhhxuq+B1W+WR7YDDvFpbx4v6zuFQTwvgUOCeTISWO8KK
oc0aIKdpkwa181E4cu7qKNmZ83z8UFf3IiNFWPkKMq4mYdmKpn+A8e0CTZ6OSeMY
WhSM4HBiIuPa+1eyxlQv62OIWkDvGZ04aTXYuBYxwsQ3uZPZ4FvUMWCcK/In4TVQ
s6BfAcBPAh3ROQyZJbpcDSPr++96XWOoXyEhhMCNT+rp+IgpykB3hTNr+qvqjK5f
zuoKGIrOY0wHBOANCMwZJwRvrDcLSbil4MY3DJhgCpBAPGdbjSLpBnbXwCy5WGGi
FC0QrgA40tuAXMUBBusNJdUAK0T6UFXl6TIf6UUHEPXHCQFH2N8=
=Y2Lc
-----END PGP SIGNATURE-----