Command line install via php flarum install --no-interaction

chriscroome

Hi, is it possible to script the installation process of Flarum by running php flarum install --no-interaction and providing arguments for all the things that the interactive install prompts for?

I'm writing a Ansible role and could template the config.php but would rather not if it is possible also perhaps that isn't all that is needed and I might have to resort to using expect to automate installs?

clarkwinkelmann

chriscroome You can run php flarum install and pass a yaml file that describes your settings after you install the code via Composer.

I'm not sure where this is documented. I'll let someone who knows explain how it works.

The source is here https://github.com/flarum/core/blob/d492579638fb52dafbfe65f1f36a95eb6047f7f3/src/Install/Console/InstallCommand.php

chriscroome

Thanks @clarkwinkelmann, that is great, do you know if there is there an example YAML config file available anywhere?

Or do I need to take the variable names from here and see if I can work out the exact file format with trial and error?

chriscroome

I've tried with a few different valid YAML files, for example in this form:

---
- name: driver
  value: 'mysql'

- name: host
  value: 'localhost'

- name: port
  value: 3306

- name: database
  value: 'flarum'

- name: username
  value: 'flarum'

And like this:

---
- name: Database Config
  driver: 'mysql'
  host: 'localhost'
  port: 3306
  database: 'flarum'
  username: 'flarum'

No joy so far... I also tried to find reference to the file format in the GitHub issues but failed to find anything... If there is an example file somewhere it would help.

clarkwinkelmann

The various options can be seen here https://github.com/flarum/core/blob/d492579638fb52dafbfe65f1f36a95eb6047f7f3/src/Install/Console/FileDataProvider.php

Seems like both json and yaml are accepted. Or you can call the install command without parameters to get prompted for the questions.

So I think it will look like this in yaml format:

debug:
baseUrl:
databaseConfiguration:
  driver:
  host:
  port:
  database:
  username:
  password:
  prefix:
adminUser:
  username:
  password:
  email:
settings:
  key: value

Most keys have a default values so you can skip them if the default works for you. Those are the default values:

debug: false
baseUrl: http://flarum.local
databaseConfiguration:
  driver: mysql
  host: localhost
  port: 3306
  database: flarum
  username: root
  password:
  prefix:
adminUser:
  username: admin
  password: password
  email: admin@example.com
settings:

chriscroome

Cheers @clarkwinkelmann that's perfect 😀.

applibs

how to add any config file into command?:
php flarum install --no-interaction

askvortsov

applibs Try php flarum install -f PATH