mirror of https://github.com/tiyn/beaker-blog
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.
51 lines
1.5 KiB
51 lines
1.5 KiB
# Python Flask Blog
|
|
|
|
This is a simple blog based on Pythons Flask framework.
|
|
|
|
## Deployment
|
|
|
|
### PIP/Python
|
|
|
|
- `pip3install -r requirements.txt` - install depenencies
|
|
- run `python app.py`
|
|
- blog is available on port 5000
|
|
|
|
### Docker
|
|
|
|
#### Volumes
|
|
|
|
Set the following volumes with the -v tag.
|
|
|
|
| Volume-Name | Container mount | Description |
|
|
|-------------|----------------------|-----------------------------------------------------------------------|
|
|
| css | /blog/src/static/css | Directory for css files |
|
|
| html | /blog/src/templates | Directory for templates and html documents (contains entry directory) |
|
|
|
|
#### Ports
|
|
|
|
Set the following ports with the -p tag.
|
|
|
|
| Container-Port | Recommended outside port | Protocol | Description |
|
|
|----------------|--------------------------|----------|-------------|
|
|
| 5000 | 80 | TCP | HTTP port |
|
|
|
|
#### Example run-command
|
|
|
|
`docker run --name blog --restart unless-stopped -v css:/blog/src/static/css -v html:/blog/src/templates -p 80:5000 -d tiynger/flaskblog`
|
|
|
|
## Usage
|
|
|
|
### Create entries
|
|
|
|
Blog entries are managed by plain html files in the `templates/entry/` directory.
|
|
The first line of each document is reserved as the title of the document.
|
|
You have to specify the filetype by extension.
|
|
|
|
Currently supported filetypes are:
|
|
- HTML (.html)
|
|
- Markdown (.md)
|
|
|
|
## To-Do
|
|
|
|
- CSS upgrade
|