diff --git a/README.md b/README.md index 7ea53b3..21131b6 100644 --- a/README.md +++ b/README.md @@ -10,7 +10,20 @@ Use `gunicorn -w 2 'flaskr:create_app()'` to run app. Increase the number of wor ## Initializing database The first time you install the app in each environment, you need to initialize database using `flask --app flaskr init-db`. This only needs to be run once per environment, and **will delete existing database if run again**. -## Secret key +## Config file + +The config file is located at `/var/flaskr-instance/config.py` in production, and in `instance/` in development. The instance folder is created when the database is initialized. + +### Secret Key Every website with login needs a secret key to hash passwords with. -`/var/flaskr-instance/config.py` must contain a line `SECRET_KEY = '`, which must be randomly generated. +The config file must contain a line `SECRET_KEY = '`, which must be randomly generated. Suggested way of generating the key is `python -c 'import secrets; print(secrets.token_hex())'`, which returns a hexadecimal string with length 64. You may choose to randomly generate a key using a different method, but ensure that it is resistant to brute-force attacks. + +### Registration +Since this blog is meant to be updated by a limited number of people, registration is forbidden (403) by default. In addition, registration (/auth/register) and login (/auth/login) URLs are not hyperlinked anywhere. Registration can be opened by including `REGISTER = True`, and is closed by default. + +### Name +The default app name is "Flaskr", and it is visible on the header bar as well as the page title. Including a line `NAME = ''` in the config file replaces "Flaskr" with your chosen name. + +### Static folder +The default static folder is the one included in the repository. You can use a separate static folder to use your own assets by including a line `STATIC_FOLDER = ''` in the config file. diff --git a/flaskr/__init__.py b/flaskr/__init__.py index ed7d989..efa74c8 100644 --- a/flaskr/__init__.py +++ b/flaskr/__init__.py @@ -8,6 +8,8 @@ def create_app(test_config=None): app.config.from_mapping( SECRET_KEY='dev', DATABASE=os.path.join(app.instance_path, 'flaskr.sqlite'), + REGISTER=False, + NAME='Flaskr' ) app.wsgi_app = ProxyFix( @@ -21,6 +23,9 @@ def create_app(test_config=None): # load the test config if passed in app.config.from_mapping(test_config) + if app.config.get('STATIC_FOLDER') is not None: + app.static_folder = app.config.get('STATIC_FOLDER') + # ensure the instance folder exists try: os.makedirs(app.instance_path) diff --git a/flaskr/auth.py b/flaskr/auth.py index e41998c..f76418e 100644 --- a/flaskr/auth.py +++ b/flaskr/auth.py @@ -1,7 +1,7 @@ import functools from flask import ( - Blueprint, flash, g, redirect, render_template, request, session, url_for + Blueprint, flash, g, redirect, render_template, request, session, url_for, current_app, abort ) from werkzeug.security import check_password_hash, generate_password_hash @@ -11,6 +11,8 @@ bp = Blueprint('auth', __name__, url_prefix='/auth') @bp.route('/register', methods=('GET', 'POST')) def register(): + if not current_app.config['REGISTER']: + abort(403) if request.method == 'POST': username = request.form['username'] password = request.form['password'] diff --git a/flaskr/blog.py b/flaskr/blog.py index cfa78d8..ec37df5 100644 --- a/flaskr/blog.py +++ b/flaskr/blog.py @@ -66,6 +66,13 @@ def get_post(id, check_author=True): return post +@bp.route('/') +def post(id): + post = get_post(id, check_author=False) + post = dict(post) + post['body'] = markdown.markdown(post['body']) + return render_template('blog/post.html', post=post) + @bp.route('//update', methods=('GET', 'POST')) @login_required def update(id): @@ -101,3 +108,7 @@ def delete(id): db.execute('DELETE FROM post WHERE id = ?',(id,)) db.commit() return redirect(url_for('blog.index')) + +@bp.route('/temp') +def temp(): + return render_template('temp.html') diff --git a/flaskr/templates/base.html b/flaskr/templates/base.html index a2c26cd..b06559b 100644 --- a/flaskr/templates/base.html +++ b/flaskr/templates/base.html @@ -1,19 +1,19 @@ -{% block title %}{% endblock %} - Flaskr +{% block title %}{% endblock %} - {{ config['NAME'] }} +
+
+
{% block header %}{% endblock %} diff --git a/flaskr/templates/blog/index.html b/flaskr/templates/blog/index.html index ffd9fbc..d5a9167 100644 --- a/flaskr/templates/blog/index.html +++ b/flaskr/templates/blog/index.html @@ -12,14 +12,13 @@
-

{{ post['title'] }}

+

{{ post['title'] }}

by {{ post['username'] }} on {{ post['created'].strftime('%Y-%m-%d') }}
{% if g.user['id'] == post['author_id'] %} - Edit - {% endif %} + Edit + {% endif %}
-

{{ post['body']|safe }}

{% if not loop.last %}
diff --git a/flaskr/templates/blog/post.html b/flaskr/templates/blog/post.html new file mode 100644 index 0000000..701a37f --- /dev/null +++ b/flaskr/templates/blog/post.html @@ -0,0 +1,20 @@ +{% extends 'base.html' %} + +{% block header %} +

{% block title %}{{ post['title']}}{% endblock %}

+{% endblock %} + +{% block content %} +
+
+
+

{{ post['title'] }}

+
by {{ post['username'] }} on {{ post['created'].strftime('%Y-%m-%d') }}
+
+ {% if g.user['id'] == post['author_id'] %} + Edit + {% endif %} +
+

{{ post['body']|safe }}

+
+{% endblock %} diff --git a/requirements.txt b/requirements.txt index 3f319fd..0e3f2aa 100644 --- a/requirements.txt +++ b/requirements.txt @@ -8,7 +8,7 @@ dnspython==2.3.0 email-validator==2.0.0.post2 exceptiongroup==1.1.1 Flask==2.3.2 --e git+https://gitlab.com/pvtejas/based4tech.git@4be89bd767a7c5a84ab62fbf4ad924ae1af077f1#egg=flaskr +-e git+https://gitlab.com/pvtejas/based4tech.git@bda624e4dc1cf97ba2b5b3fcb66a5b28398307bc#egg=flaskr gunicorn==20.1.0 h11==0.14.0 httpcore==0.17.0