[v3,2/2] Introduce conf/config.dev for development

Message ID 20200603000402.GA666805@tsubame.mg0.fr
State New
Headers show
Series
  • Untitled series #785
Related show

Commit Message

Frédéric Mangano-Tarumi June 3, 2020, 12:04 a.m. UTC
conf/config.dev’s purpose is to provide a lighter configuration template
for developers, and split development-specific options off the default
configuration file.
---
 TESTING              | 11 ++++++-----
 conf/config.defaults | 10 ----------
 conf/config.dev      | 32 ++++++++++++++++++++++++++++++++
 3 files changed, 38 insertions(+), 15 deletions(-)
 create mode 100644 conf/config.dev

Comments

Lukas Fleischer June 3, 2020, 12:09 a.m. UTC | #1
On Tue, 02 Jun 2020 at 20:04:02, Frédéric Mangano-Tarumi wrote:
> conf/config.dev\u2019s purpose is to provide a lighter configuration template
> for developers, and split development-specific options off the default
> configuration file.
> ---
>  TESTING              | 11 ++++++-----
>  conf/config.defaults | 10 ----------
>  conf/config.dev      | 32 ++++++++++++++++++++++++++++++++
>  3 files changed, 38 insertions(+), 15 deletions(-)
>  create mode 100644 conf/config.dev

Looks good to me. Merged (together with patch 1/2), thanks!

Patch

diff --git a/TESTING b/TESTING
index 31e3bcbd..7261df92 100644
--- a/TESTING
+++ b/TESTING
@@ -17,12 +17,13 @@  INSTALL.
 
    Ensure to enable the pdo_sqlite extension in php.ini.
 
-3) Copy conf/config.defaults to conf/config and adjust the configuration
-   Pay attention to disable_http_login, enable_maintenance, aur_location and
-   htmldir.
+3) Copy conf/config.dev to conf/config and replace YOUR_AUR_ROOT by the absolute
+   path to the root of your aurweb clone. sed can do both tasks for you:
 
-   Be sure to change backend to sqlite and name to the file location of your
-   created test database.
+    $ sed -e "s;YOUR_AUR_ROOT;$PWD;g" conf/config.dev > conf/config
+
+   Note that when the upstream config.dev is updated, you should compare it to
+   your conf/config, or regenerate your configuration with the command above.
 
 4) Prepare the testing database:
 
diff --git a/conf/config.defaults b/conf/config.defaults
index ed495168..447dacac 100644
--- a/conf/config.defaults
+++ b/conf/config.defaults
@@ -41,16 +41,6 @@  cache = none
 cache_pkginfo_ttl = 86400
 memcache_servers = 127.0.0.1:11211
 
-[php]
-; Address PHP should bind when spawned in development mode by aurweb.spawn.
-bind_address = 127.0.0.1:8081
-; Directory containing aurweb's PHP code, required by aurweb.spawn.
-;htmldir = /path/to/web/html
-
-[fastapi]
-; Address uvicorn should bind when spawned in development mode by aurweb.spawn.
-bind_address = 127.0.0.1:8082
-
 [ratelimit]
 request_limit = 4000
 window_length = 86400
diff --git a/conf/config.dev b/conf/config.dev
new file mode 100644
index 00000000..d752f61f
--- /dev/null
+++ b/conf/config.dev
@@ -0,0 +1,32 @@ 
+; Configuration file for aurweb development.
+;
+; Options are implicitly inherited from conf/config.defaults, which lists all
+; available options for productions, and their default values. This current file
+; overrides only options useful for development, and introduces
+; development-specific options too.
+
+[database]
+backend = sqlite
+name = YOUR_AUR_ROOT/aurweb.sqlite3
+
+; Alternative MySQL configuration
+;backend = mysql
+;name = aurweb
+;user = aur
+;password = aur
+
+[options]
+aur_location = http://127.0.0.1:8080
+disable_http_login = 0
+enable-maintenance = 0
+
+[php]
+; Address PHP should bind when spawned in development mode by aurweb.spawn.
+bind_address = 127.0.0.1:8081
+
+; Directory containing aurweb's PHP code, required by aurweb.spawn.
+htmldir = YOUR_AUR_ROOT/web/html
+
+[fastapi]
+; Address uvicorn should bind when spawned in development mode by aurweb.spawn.
+bind_address = 127.0.0.1:8082