Simple Admin Configurations

Database Configuration

Parameter Name	Required	Default Value	Parameter Description
Type	Yes	mysql	Supported types: mysql, postgres, sqlite3
Host	Yes		Database address, such as localhost, 127.0.0.1
Port	Yes		Database port, such as 3306
Username	Yes	root	Database username
Password	No		Database password
DBName	Yes	simple_admin	Database name
SSLMode	No		Whether to use SSL in postgresql, options: disable or require
DBPath	No		Location to store the Sqlite database file, must be set when using sqlite3, e.g., /home/data/sqlite.db
MysqlConfig	No		Additional configuration for MySQL, such as &charset=utf8&loc=Asia%2fShanghai
PGConfig	No		Additional configuration for PostgreSQL
SqliteConfig	No		Additional configuration for Sqlite
CacheTime	No	10	Cache time (in seconds)
MaxOpenConn	No	100	Maximum number of simultaneous connections
Debug	No	false	Whether to enable debug mode and write query statements to the log

Example

DatabaseConf:
  Type: postgres
  Host: localhost
  Port: 5432
  DBName: simple_admin
  Username: postgres
  Password: 'simple-admin.'
  MaxOpenConn: 100
  SSLMode: disable # disable or require
  CacheTime: 5
  Debug: false

Cross-Origin Configuration

Parameter Name	Required	Default Value	Parameter Description
Address	No	*	If set to *, allows cross-origin requests from any domain. Otherwise, specify your own domain or IP.

Example

CROSConf:
  Address: '*'

Casbin Configuration

Parameter Name	Required	Default Value	Parameter Description
ModelText	No	...	Casbin rules

Example

CasbinConf:
  ModelText: |
    [request_definition]
    r = sub, obj, act
    [policy_definition]
    p = sub, obj, act
    [role_definition]
    g = _, _
    [policy_effect]
    e = some(where (p.eft == allow))
    [matchers]
    m = r.sub == p.sub && keyMatch2(r.obj,p.obj) && r.act == p.act

I18n Configuration

Only used when i18n needs to read from an external directory.

Parameter Name	Required	Default Value	Parameter Description
Dir	No	...	External i18n file directory, if empty, read embeded files, if not empty, read the files under the specified path

Example

I18nConf:
  Dir: "D:/projects/simpleadmin/feature-workspace/simple-admin-core/api/internal/i18n/"

Auth Authentication Configuration

Parameter Name	Required	Default Value	Parameter Description
AccessSecret	Yes		JWT encryption key
AccessExpire	Yes		JWT expiration time

Example

Auth:
  AccessSecret: jS6VKDtsJf3z1n2VKDtsJf3z1n2 # Consistent encryption key for JWT across all APIs for successful decoding
  AccessExpire: 259200 # Seconds, expiration time

Native Redis Configuration

  config.RedisConf

Parameter Name	Required	Default Value	Parameter Description
Host	Yes		Redis server address, supports comma-separated if it's a cluster
Db	Yes	0	Redis database ID
Username	No		Redis username
Pass	No		Redis password
Tls	No		Whether to enable TLS encryption
PoolSize	No	48	Connection pool size
MaxIdleConns	No	12	Maximum idle connections

Core Project Configuration

Parameter Name	Required	Default Value	Parameter Description
DefaultRole	Yes	1	Default role ID for registered users
DefaultDepartment	Yes	1	Default department ID for registered users
DefaultPosition	Yes	1	Default position ID for registered users
EmailCaptchaExpiredTime	No	600	Default expiration time for email verification code
SmsTemplateId	No		Default SMS template ID
SmsAppId	No		Default SMS app ID
SmsSignName	No		Default SMS signature
SmsParamsType	No		Default SMS parameters type, supports json and array
RegisterVerify	Yes		Registration verification method, supports captcha, email, sms, sms_or_email
LoginVerify	Yes		Login verification method, supports captcha, email, sms, sms_or_email, all
ResetVerify	Yes		Reset verification method, supports email, sms, sms_or_email
AllowInit	Yes	true	Whether to allow database initialization

Example

ProjectConf:
  DefaultRoleId: 2
  DefaultDepartmentId: 3
  DefaultPositionId: 1
  EmailCaptchaExpiredTime: 600
  SmsTemplateId: 'xxx'
  SmsAppId: 'xxx'
  SmsSignName: 'xxx'
  SmsParamsType: json
  RegisterVerify: sms
  LoginVerify: captcha
  ResetVerify: email
  AllowInit: true