A blog system based on plain-files.
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

50 lines
1.5 KiB

7 months ago
7 months ago
7 months ago
7 months ago
7 months ago
  1. # Python Flask Blog
  2. This is a simple blog based on Pythons Flask framework.
  3. ## Usage
  4. ### Create entries
  5. Blog entries are managed by plain html files in the `templates/entry/` directory.
  6. The first line of each document is reserved as the title of the document.
  7. You have to specify the filetype by extension.
  8. Currently supported filetypes are:
  9. - HTML (.html)
  10. - Markdown (.md)
  11. ## To-Do
  12. - CSS upgrade
  13. ## Deployment
  14. ### PIP/Python
  15. - `pip3install -r requirements.txt` - install depenencies
  16. - run `python app.py`
  17. - blog is available on port 5000
  18. ### Docker
  19. #### Volumes
  20. Set the following volumes with the -v tag.
  21. | Volume-Name | Container mount | Description |
  22. |-------------|----------------------|-----------------------------------------------------------------------|
  23. | css | /blog/src/static/css | Directory for css files |
  24. | html | /blog/src/templates | Directory for templates and html documents (contains entry directory) |
  25. #### Ports
  26. Set the following ports with the -p tag.
  27. | Container-Port | Recommended outside port | Protocol | Description |
  28. |----------------|--------------------------|----------|-------------|
  29. | 5000 | 80 | TCP | HTTP port |
  30. #### Example run-command
  31. `docker run --name blog --restart unless-stopped -v css:/blog/src/static/css -v html:/blog/src/templates -p 80:5000 -d tiynger/flaskblog`