2017 © Pedro Peláez
 

project autobahn

Autobahn is the Ueberholspur for your Composer-based WordPress stack. German Engineering.

image

mrgrain/autobahn

Autobahn is the Ueberholspur for your Composer-based WordPress stack. German Engineering.

  • Friday, August 18, 2017
  • by mrgrain
  • Repository
  • 1 Watchers
  • 2 Stars
  • 92 Installations
  • PHP
  • 0 Dependents
  • 0 Suggesters
  • 2 Forks
  • 0 Open issues
  • 10 Versions
  • 0 % Grown

The README.md

Autobahn

Autobahn is the Ueberholspur for your Composer-based WordPress stack. German Engineering., (*1)

Quick start

This requires Composer and Vagrant to be properly set up on your machine. If not, please skip to the documentation., (*2)

Create a new project by running:, (*3)

composer create-project mrgrain/autobahn

and start your local Vagrant environment with:, (*4)

vagrant up

Open your browser and navigate to my.autobahn.rocks. That's all! You can login to the admin panel using admin/password as credentials., (*5)

License

The mrgrain/autobahn package is open-sourced software licensed under the GPL-3.0 license., (*6)

Documentation

Installation

Use composer to create a new project, (*7)

composer create-project mrgrain/autobahn

... or clone the git repository and run composer install., (*8)

git clone https://github.com/mrgrain/autobahn.git autobahn
cd autobahn
composer install

Vagrant setup

Provisioning your Vagrant virtual machine will execute all required steps:, (*9)

vagrant up

Manual setup

After installing composer dependencies, set up the basic configuration by copying .env.example to .env and adjust it to your needs:, (*10)

cp .env.example .env
vim .env

This most likely requires you to change the database connection details and set an appropriate WP_HOME URL., (*11)

Next generate the WordPress security keys using Autobahn CLI:, (*12)

./vendor/bin/autobahn keys:generate

Finally, run the WordPress install via wp-cli (change URL to an appropriate value):, (*13)

./vendor/bin/wp core install --url=http://localhost

Basic usage

.env file

Sensitive environment configuration should be stored in the .env file based in your root directory., (*14)

autobahn.json

WordPress configuration has to be set in the autobahn.json file in based in your root directory., (*15)

Files setup

autobahn
|-- public              # web server root
|   |-- app             # renamed `wp-content` directory
|   |   |-- mu-plugins
|   |   |-- plugins
|   |   |-- themes
|   |   `-- uploads
|   |
|   |-- wp              # WordPress core files
|   |
|   |-- index.php       # main scipt entry point
|   `-- wp-config.php   # adjusted `wp-config.php` using `.env` & `autobahn.json`
|
|-- vendor              # composer dependencies
|-- .env                # environment configuration
`-- autobahn.json       # Autobahn WordPress configuration

Settings

Autobahn constants

WP_ENV - Set the environment, defaults to development. WPMU_LOADER - Path to a mu-plugins loader, see advanced configuration section., (*16)

Path constants

PUBLIC_DIR - Absolute or relative (project's root directory) path to the public web server document root directory, defaults to public/. CONTENT_DIR - Relative path (from PUBLIC_DIR) to the WordPress content directory, defaults to app/. WORDPRESS_DIR - Relative path( from PUBLIC_DIR) to the WordPress core, defaults to wpp/., (*17)

WordPress constants

All default WordPress constants are available via .env or autobahn.json., (*18)

WordPress options

Any WordPress option can be forced to a value using the options section in the autobahn.json file., (*19)

PHP configuration

Environments

Advanced Configuration

mu-plugins loader

Change public server directory

The easiest way to achieve this, is setting a symlink to the existing public directory., (*20)

# Create a symlink named "web" to the existing "public" directory
ln -s public web

However, if you need to move the files, you can do this by changing a few configuration values. First, update the composer installer-paths for plugins, themes and the WordPress install directory in your composer.json file:, (*21)

{
  "extra": {
    "installer-paths": {
      "public/app/mu-plugins/{$name}/": [
        "type:wordpress-muplugin"
      ],
      "public/app/plugins/{$name}/": [
        "type:wordpress-plugin"
      ],
      "public/app/themes/{$name}/": [
        "type:wordpress-theme"
      ]
    },
    "wordpress-install-dir": "public/wp"
  }
}

Run composer update to move all files to the new location., (*22)

Next, add PUBLIC_DIR as well as WORDPRESS_DIR and CONTENT_DIR to your autobahn.json configuration., (*23)

{
  "config": {
    "PUBLIC_DIR": "public/",
    "WORDPRESS_DIR": "wp/",
    "CONTENT_DIR": "app/"
  }
}

PUBLIC_DIR can be an absolute path or relative to the project's root directory. WORDPRESS_DIR and CONTENT_DIR are relative to the PUBLIC_DIR. Both are also added to the end of the website URL to access the WordPress admin area and plugin/themes files., (*24)

As last we'll need to change the wp-cli configuration to keep it working. Therefore update the wp-cli.yml file:, (*25)

path: public/wp
wp-content location

By default the wp-conent folder is moved to public/app. If you want to change the location of it in your project, please follow the steps described in Change public server directory, only changing the app related values., (*26)

WordPress location

By default WordPress is installed to public/wp. If you want to change the location of WordPress in your project, please follow the steps described in Change public server directory, only changing the wp related values., (*27)

wp-cli.yml

You can set any configuration for wp-cli to its wp-cli.yml file. For example you might want to globally set the url value and thus skip passing it on to every command:, (*28)

url: http://my.autobahn.rocks

Please be aware that changing the path will require further adjustments to keep everything working., (*29)

The Versions

18/08 2017

dev-master

9999999-dev

Autobahn is the Ueberholspur for your Composer-based WordPress stack. German Engineering.

  Sources   Download

GPL-3.0+

The Requires

 

The Development Requires

by Moritz Kornher

wordpress wp stack composer boilerplate

17/01 2017

0.7.1

0.7.1.0

Autobahn is the Ueberholspur for your Composer-based WordPress stack. German Engineering.

  Sources   Download

GPL-3.0+

The Requires

 

The Development Requires

by Moritz Kornher

wordpress wp stack composer boilerplate

15/07 2016

dev-autobahn-up

dev-autobahn-up

Autobahn is the Ueberholspur for your Composer-based WordPress stack. German Engineering.

  Sources   Download

GPL-3.0+

The Requires

 

The Development Requires

by Moritz Kornher

wordpress wp stack composer boilerplate

15/07 2016

0.7.0

0.7.0.0

Autobahn is the Ueberholspur for your Composer-based WordPress stack. German Engineering.

  Sources   Download

GPL-3.0+

The Requires

 

The Development Requires

by Moritz Kornher

wordpress wp stack composer boilerplate

15/07 2016

0.6.0

0.6.0.0

Autobahn is the Ueberholspur for your Composer-based WordPress stack. German Engineering.

  Sources   Download

GPL-3.0+

The Requires

 

The Development Requires

by Moritz Kornher

wordpress wp stack composer boilerplate

08/05 2016

0.5.0

0.5.0.0

Autobahn is the Ueberholspur for your Composer-based WordPress stack. German Engineering.

  Sources   Download

GPL-3.0+

The Requires

 

The Development Requires

by Moritz Kornher

wordpress wp stack composer boilerplate

11/04 2016

0.4.0

0.4.0.0

Autobahn is the Ueberholspur for your Composer-based WordPress stack. German Engineering.

  Sources   Download

GPL-3.0+

The Requires

 

The Development Requires

by Moritz Kornher

wordpress wp stack composer boilerplate

17/09 2015

0.3.0

0.3.0.0

Autobahn is the Ueberholspur for your Composer-based WordPress stack. German Engineering.

  Sources   Download

GPL-3.0+

The Requires

 

The Development Requires

by Moritz Kornher

wordpress wp stack composer boilerplate

29/07 2015

0.2.0

0.2.0.0

Autobahn is the Ueberholspur for your Composer-based WordPress stack. German Engineering.

  Sources   Download

GPL-3.0+

The Requires

 

by Moritz Kornher

wordpress wp stack composer boilerplate

14/07 2015

0.1.0

0.1.0.0

Autobahn is the Ueberholspur for your Composer-based WordPress stack. German Engineering.

  Sources   Download

GPL-3.0+

The Requires

 

by Moritz Kornher

wordpress wp stack composer boilerplate