• Docs

›Getting started

Getting started

  • Installation
  • Configuration
  • Directory Structure
  • Commands

Configuration

Setup theme

All themes in development are stored in the themes directory. Aztlan comes with aztlan, a boilerplate theme to get you started.

You can rename the theme as you wish, but you will have to change:

  • The Text Domain on style.css
  • THEME_ACTIVE variable on app.env
  • Reinstall with ./environment/bin/install

Environment files

All of configuration files for Aztlan are stored in the environment/env directory.

app.env

Application variables...

VariableDescriptionDefault
ENVApplication environment: development or productiondevelopment
DB_NAMEDatabase nameproject
DB_USERDatabase userproject
DB_PASSWORDDatabase passwordproject
DB_HOSTDatabase hostdb
DB_CHARSETDatabase charsetutf8
DB_COLLATEDatabase collate
WP_LANGWordPress languagept_BR
WP_HOMEWordPress homepage URLhttp://localhost
WP_SITEURLWordPress admin URLhttp://localhost/wp
AUTH_KEYGenerate on roots.io*
SECURE_AUTH_KEYGenerate on roots.io*
LOGGED_IN_KEYGenerate on roots.io*
NONCE_KEYGenerate on roots.io*
AUTH_SALTGenerate on roots.io*
SECURE_AUTH_SALTGenerate on roots.io*
LOGGED_IN_SALTGenerate on roots.io*
NONCE_SALTGenerate on roots.io*
WP_DEBUGEnable debug mode on WordPressfalse
ASSETS_URLWebpack dist URLhttp://localhost/assets
THEME_ACTIVEActive theme nameenv-theme

*roots.io/salts

build.env

Build variables...

VariableDescriptionDefault
VERSIONVersion of the image that will be built0.1
REGISTRY_ENDPOINTRegistry endpointlocalhost:5000
REPOSITORY_NAMERepository nameaztlan
WP_LANGWP languagept_BR

deploy.env

Deploy variables...

VariableDescriptionDefault
DEP_HTTP_USERHttp user on deploy serverwww-data
DEP_REPOSITORYRepository on git
DEP_STG_HOSTStaging host
DEP_STG_PORTStaging port
DEP_STG_USERStaging user
DEP_STG_PATHStaging path
DEP_STG_BRANCHStaging branch
DEP_PROD_HOSTProduction host
DEP_PROD_PORTProduction port
DEP_PROD_USERProduction user
DEP_PROD_PATHProduction path
DEP_PROD_BRANCHProduction branch

install.env

Installation variables...

VariableDescriptionDefault
WP_BASHThe bash executable that will be run WP-CLI${COMPOSE} run --rm wp bash
CLI_COMPOSERcli-composer composer command${COMPOSE} run --rm cli-composer
INC_COMPOSERinc-composer composer command${COMPOSE} run --rm inc-composer
WP_COMPOSERwp-composer composer command${COMPOSE} run --rm wp-composer
PHPQA_COMPOSERwp-composer composer command${COMPOSE} run --rm phpqa-composer
NPMNPM command${COMPOSE} run --rm assets-node npm
WP_TITLESite titleWordPress
WP_USERAdmin username*admin
WP_PASSWORDAdmin password*admin
WP_EMAILAdmin email*[email protected]
COPY_START_UPLOADSDefine if the uploads on environment/extra/uploads must be copiedtrue
UPLOADS_DIRthe place where will be copied the uploads storedpublic/packages/uploads
SET_PERMISSIONSDefine if the permissions will be set with www-data user as ownertrue
PERMALINKDefine the permalink structure/%postname%/
SET_PRE_COMMITDefine if pre-commit will be activetrue

* Do not use this default values in production

mysql.env

Database variables...

Do not use this default values in production

VariableDescriptionDefault
MYSQL_ROOT_PASSWORDDatabase root passwordroot
MYSQL_DATABASEDatabase nameproject
MYSQL_USERDatabase userproject
MYSQL_PASSWORDDatabase passwordproject

xdebug.env

XDebug variables...

VariableDescriptionDefault
PHP_XDEBUG_PROFILE_ENABLEProfile enableOff
PHP_XDEBUG_REMOTE_ENABLERemote enableOn
PHP_XDEBUG_REMOTE_HOSTRemote host10.254.254.254
PHP_XDEBUG_AUTO_TRACEAuto traceOff
PHP_XDEBUG_IDEKEYIDE keyVSCODE
← InstallationDirectory Structure →
  • Setup theme
  • Environment files
    • app.env
    • build.env
    • deploy.env
    • install.env
    • mysql.env
    • xdebug.env
Powered By
Aztec Web

Aztec Web

Docs
Getting Started
More
GitHubStar
Copyright © 2022 Aztlan