LemmyNet
/
lemmy
3
2
Fork 3
Code Pull Requests 1 Releases Wiki Activity

Improve config files by adding documentation and removing some fields #61

Manually merged
dessalines merged 2 commits from improve-config into master 2020-06-27 14:16:04 +00:00
Conversation 4 Commits 2 Files Changed 4 +45 -49
nutomic commented 2020-06-24 14:11:20 +00:00
Owner
Copy Link

Havent tested this yet, but its really just shuffling some things around and adding comments.

Btw we should specify in the docker install docs that people need to change the jwt_secret.

Havent tested this yet, but its really just shuffling some things around and adding comments. Btw we should specify in the docker install docs that people need to change the jwt_secret.
dessalines requested changes 2020-06-24 19:29:32 +00:00
dessalines left a comment
Owner
Copy Link

Just one thing. And maybe the config.hjson and lemmy.hjson should be identical, and contain all of the config options.

Just one thing. And maybe the config.hjson and lemmy.hjson should be identical, and contain all of the config options.
docker/lemmy.hjson
@ -23,4 +26,0 @@
jwt_secret: "changeme"
# The dir for the front end
front_end_dir: "/app/dist"
# rate limits for various user actions, by user ip
dessalines commented 2020-06-24 19:28:33 +00:00
Owner
Copy Link

Why remove this stuff? Its the only place its documented.

Why remove this stuff? Its the only place its documented.
nutomic commented 2020-06-24 21:36:57 +00:00
Author
Owner
Copy Link

Sorry I should have mentioned why I'm changing this. Mainly I'm trying to make the manual installation easier, by reducing the number of fields in the config file used for that. These removed options and their documentation are still in server/config/defaults.hjson (which is linked from the docs). So this PR shouldnt change any of the behaviour.

Later we should also clarify in the docs for manual installation which config fields actually need to be changed, because people are confused about that.

Sorry I should have mentioned why I'm changing this. Mainly I'm trying to make the manual installation easier, by reducing the number of fields in the config file used for that. These removed options and their documentation are still in `server/config/defaults.hjson` (which is linked from the docs). So this PR shouldnt change any of the behaviour. Later we should also clarify in the docs for manual installation which config fields actually need to be changed, because people are confused about that.
dessalines commented 2020-06-25 21:57:22 +00:00
Owner
Copy Link

Good thing I tested this, it would've broken master.

lemmy_1     | [2020-06-25T21:49:38Z ERROR actix_files] Specified path is not a directory: "../ui/dist"
lemmy_1     | [2020-06-25T21:49:38Z ERROR actix_files] Specified path is not a directory: "../ui/dist/documentation"

Scratch what I wrote twice lol.

You can't really change that front_end_dir as ../ui/dist in defaults.hjson, bc it would break local builds. So it needs to be re-added to lemmy.hjson.

Good thing I tested this, it would've broken master. ``` lemmy_1 | [2020-06-25T21:49:38Z ERROR actix_files] Specified path is not a directory: "../ui/dist" lemmy_1 | [2020-06-25T21:49:38Z ERROR actix_files] Specified path is not a directory: "../ui/dist/documentation" ``` Scratch what I wrote twice lol. You can't really change that `front_end_dir` as `../ui/dist` in `defaults.hjson`, bc it would break local builds. So it needs to be re-added to lemmy.hjson.
nutomic requested review from dessalines 2020-06-26 17:17:16 +00:00
nutomic commented 2020-06-26 17:17:59 +00:00
Author
Owner
Copy Link

Sorry about that. I put that back in and tried it on a test server. Also noticed that the link to the default config wasnt working in the compiled docs and fixed that.

Sorry about that. I put that back in and tried it on a test server. Also noticed that the link to the default config wasnt working in the compiled docs and fixed that.
dessalines commented 2020-06-27 14:12:16 +00:00
Owner
Copy Link

I'm testing now.

I'm testing now.
dessalines manually merged commit b6fc1959e6 into master 2020-06-27 14:16:04 +00:00
nutomic deleted branch improve-config 2020-06-27 19:17:11 +00:00
Sign in to join this conversation.
Reviewers
No reviewers
dessalines
Labels
Clear labels
No items
No Label
Milestone
Clear milestone
No items
No Milestone
Assignees
Clear assignees
No Assignees
2 Participants
Notifications
Due Date
The due date is invalid or out of range. Please use the format 'yyyy-mm-dd'.

No due date set.

Dependencies

No dependencies set.

Reference: LemmyNet/lemmy#61
No description provided.
Delete Branch "improve-config"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?