Page MenuHomeMusing Studio

Simplified application install
Open, Medium-HighPublic

Description

Overview

Make the installation process shorter by condensing it into one step.

Background

Right now it takes 2-4 steps to set up the application, excluding MySQL, Nginx, TLS certificate, and Systemd setup. We should simplify the application install (everything else is out of scope for this task).

Users

Admins

Implementation

Create new writefreely --install command. This should replace --config, --init-db, and --gen-keys steps. Notes:

  • We should assume that the configured database already exists -- the CREATE DATABASE step will now need to happen before install.
  • We might want to prompt user for keys dir location during configuration, since they won't have a chance to change that config value before --gen-keys is run.
    • Pro: save some steps (update config file, move keys dir)
    • Con: slightly complicates install process for average person that isn't too concerned about location

Event Timeline

matt edited projects, added WriteFreely; removed WriteFreely (v1.0).
matt raised the priority of this task from Normal to Medium-High.Oct 15 2024, 5:17 PM
matt moved this task from Post-v1.0 to Backlog on the WriteFreely board.

This will be aimed primarily at people hoping to start up an instance quickly, whether to demo or test it out. It should include a confirmation step:

This will quickly set up a brand new WriteFreely instance.

Note: this doesn't configure everything you might need, like custom directories for server resources. If you need more control over the process, follow the <setup guide>.

Do you want to continue? [y/N] _