Add a default configuration file #73

Ember · 2022-11-27T05:08:49+01:00

Ember commented

2022-11-27 05:08:49 +01:00

This pull request adds a default configuration file at instance/config.py. This configuration file is pre-populated with all the default values, along with a short block of documentation explaining what each option does.

The goal is to help ease the process of starting up a new instance. By making setup easier to understand and reducing overall friction, more admins will be able to spin up instances quicker and easier.

Let me know what you think of the documentation, and if I've made any mistakes in my descriptions.

As a note, I've omitted SQLALCHEMY_TRACK_MODIFICATIONS and PREFERRED_URL_SCHEME, as SQLALCHEMY_TRACK_MODIFICATIONS seems to be 0x0 configuring sqlalchemy moreso than something that can be configured about 0x0? And PREFERRED_URL_SCHEME seemed to permit http requests just fine even when set to https, so I couldn't really figure out a reason for it to be anything but https. However, I might be wrong about these things, and if so, I'll add them back.

This pull request adds a default configuration file at `instance/config.py`. This configuration file is pre-populated with all the default values, along with a short block of documentation explaining what each option does. The goal is to help ease the process of starting up a new instance. By making setup easier to understand and reducing overall friction, more admins will be able to spin up instances quicker and easier. Let me know what you think of the documentation, and if I've made any mistakes in my descriptions. As a note, I've omitted `SQLALCHEMY_TRACK_MODIFICATIONS` and `PREFERRED_URL_SCHEME`, as `SQLALCHEMY_TRACK_MODIFICATIONS` seems to be 0x0 configuring sqlalchemy moreso than something that can be configured about 0x0? And `PREFERRED_URL_SCHEME` seemed to permit `http` requests just fine even when set to `https`, so I couldn't really figure out a reason for it to be anything but `https`. However, I might be wrong about these things, and if so, I'll add them back.

Ember added 2 commits 2022-11-27 05:08:49 +01:00

86d9ba5487 Add a default configuration file

103993c7a0 Update the README to reflect the existence of the config file

Ember force-pushed default-config from 103993c7a0 to da2357183c

2022-11-27 05:10:14 +01:00

Compare

mia commented

2022-11-28 11:28:11 +01:00

I suggest calling the file config.py.example so that pulling from the git repository will not conflict with existing/modified files.

I suggest calling the file `config.py.example` so that pulling from the git repository will not conflict with existing/modified files.

👍 1

Ember added 1 commit 2022-11-28 17:58:59 +01:00

32118c2cc8

Move the default config to a .example.py file

Ember commented

2022-11-28 17:59:37 +01:00

Done! And the README updated to match

mia requested changes 2022-11-28 19:27:23 +01:00

mia left a comment

Just minor corrections, then it’ll be good to merge. Thanks!

instance/config.example.py Outdated

					
				@ -0,0 +25,4 @@

				# sqlite:/// + /path/to/your/database.db

				#

				# Until https://git.0x0.st/mia/0x0/issues/70 is resolved, it's recommended that

				# any sqlite databases use an absolute paths, as relative paths aren't

mia commented

2022-11-28 19:23:39 +01:00

absolute paths → absolute path

👍 1

Ember marked this conversation as resolved

instance/config.example.py Outdated

					
				@ -0,0 +89,4 @@

				# file to have the file extension that matches.

				#

				# For example, if the user uploads "myfile.png", but the file is actually a

				# jpg, the file will get a URL like "eAa.jpg"

mia commented

2022-11-28 19:22:30 +01:00

This is not true: This dict specifies overrides for python-magic’s default file extensions for each MIME type. Sometimes that’s something silly. It is only used when a file is uploaded without a file name extension.

Ember commented

2022-11-28 21:40:04 +01:00

Oh oops! I badly misread the code there 😅

Ember marked this conversation as resolved

Ember added 1 commit 2022-11-28 21:39:35 +01:00

dd7f7eff38

Corrections as per request