Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Distribute a default data/options.dist.php #166

Closed
nodiscc opened this issue Mar 12, 2015 · 6 comments
Closed

Distribute a default data/options.dist.php #166

nodiscc opened this issue Mar 12, 2015 · 6 comments
Labels
easy good place to start contributing enhancement
Milestone

Comments

@nodiscc
Copy link
Member

nodiscc commented Mar 12, 2015

data/options.dist.php should contain a copy of all configurable settings (those listed in index.php) and their defaults. Anytime, if data/options.php doesn't exist, recreate it by copying data/options.dist.php -> data/options.php.

This prevents temptation to edit index.php directly and presents all available options to users directly in the config file.

@nodiscc nodiscc added this to the 0.9beta milestone Mar 12, 2015
@nodiscc nodiscc added enhancement easy good place to start contributing labels Mar 12, 2015
@virtualtam
Copy link
Member

this may become invalid/unnecessary after #255

@ArthurHoaro
Copy link
Member

config.php now contains all settings, including credentials. If the file is deleted, install() will be called to recreate it with valid values.

To prevent edition in index.php, we can add:

// DO NOT FUCKING TOUCH THESE! Change them in /data/config.php.

I suggest we close this as wontfix.

@virtualtam
Copy link
Member

Agreed for closing as won't fix

Regarding settings, there's a nice module to politely handle user mistakes: ArnoldC :D

@virtualtam
Copy link
Member

I've moved the configuration-related documentation to a dedicated page, and replaced the available option list with a commented version of data/config.php

@ArthurHoaro
Copy link
Member

👍

@nodiscc
Copy link
Member Author

nodiscc commented Jul 12, 2015

config.php now contains all settings, including credentials. If the file is deleted, install() will be called to recreate it with valid values.

That was the point of this issue. Thanks!

@nodiscc nodiscc closed this as completed Jul 12, 2015
@virtualtam virtualtam modified the milestones: 0.9.0, 0.5.0 Jul 30, 2015
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
easy good place to start contributing enhancement
Projects
None yet
Development

No branches or pull requests

3 participants