Backend Config File

⌘ K

Config File Overview

Using go-admin for the first time needs one round of initial setup, mainly the database connection. MySQL is recommended, or you can get going quickly with the SQLite demo database the repo ships with (some features, like code generation, aren't supported there).

Open config/settings.yml and focus on the database section:

yml

settings:
  database:
    driver: mysql
    source: user:password@tcp(127.0.0.1:3306)/dbname?charset=utf8&parseTime=True&loc=Local&timeout=5000ms

Swap the three parts of source for your own:

user — the database username
password — the database password
dbname — the database name, which needs to exist beforehand

The remaining config sections (application, jwt, logger, gen, etc.) can stay at their defaults and things will run — the full field reference is in the Config Reference. The current version has no application.logpath field — the log path is logger.path.

WARNING

Before going to production, jwt.secret must be replaced with a random string (the default is go-admin), and application.mode must be set to prod. See the Config Reference for details.

WARNING

Where to get help:

If anything in this guide is unclear, please open an issue.

‌
‌
‌
‌

Config File Overview

Using go-admin for the first time needs one round of initial setup, mainly the database connection. MySQL is recommended, or you can get going quickly with the SQLite demo database the repo ships with (some features, like code generation, aren't supported there).

Open config/settings.yml and focus on the database section:

yml

settings:
  database:
    driver: mysql
    source: user:password@tcp(127.0.0.1:3306)/dbname?charset=utf8&parseTime=True&loc=Local&timeout=5000ms

Swap the three parts of source for your own:

user — the database username
password — the database password
dbname — the database name, which needs to exist beforehand

The remaining config sections (application, jwt, logger, gen, etc.) can stay at their defaults and things will run — the full field reference is in the Config Reference. The current version has no application.logpath field — the log path is logger.path.

WARNING

Before going to production, jwt.secret must be replaced with a random string (the default is go-admin), and application.mode must be set to prod. See the Config Reference for details.

WARNING

Where to get help:

If anything in this guide is unclear, please open an issue.

TABLE OF CONTENTS

TABLE OF CONTENTS

Config File Overview

WARNING

WARNING

Config File Overview

WARNING

WARNING