Dotenv configuration
The following properties can be set in a .env.local
file in the root of the project:
APP_ENV=prodAPP_SECRET=9653a6c476d291323d2db7417c13a814DATABASE_URL="mysql://db:db@db:3306/db?serverVersion=mariadb-10.3.39&charset=utf8"MESSENGER_TRANSPORT_DSN=doctrine://default?auto_setup=0MAILER_DSN=native://defaultTYPESENSE_URL=http://typesense:8108TYPESENSE_KEY=xyzBOOK_FOLDER_NAMING_FORMAT="{authorFirst}/{author}/{title}/{serie}"BOOK_FILE_NAMING_FORMAT="{serie}-{serieIndex}-{title}"KOBO_PROXY_USE_EVERYWHERE=0KOBO_PROXY_ENABLED=1ALLOW_BOOK_RELOCATION=1
APP_ENV
: The environment the application is running in. This can bedev
orprod
. You should always useprod
unless you need to debug the application.APP_SECRET
: A secret key used to secure the application. Make it unique!DATABASE_URL
: The URL to the database. You should not need to change this unless you are using a different database.MESSENGER_TRANSPORT_DSN
: Do not change it.MAILER_DSN
: Currently not used.TYPESENSE_URL
: The URL to the typesense server. You should not need to change this unless you are using a different server.TYPESENSE_KEY
: The key to access the typesense server. Needs to correspond to the one you set in your docker-compose file.TYPESENSE_EMBED_MODEL
: Embed model, default is the built-ints/all-MiniLM-L12-v2
model. You can use an OpenAi/Palm/Vertex model. Example:openai/text-embedding-3-small
.TYPESENSE_EMBED_NUM_DIM
: Dimension of the embed model.all-MiniLM-L12-v2
is 384,text-embedding-3-small
is 1536. Read your model documentation to know the dimension.TYPESENSE_EMBED_KEY
: Authentication for the embed model. Default is~
, but you can set a token if you use an external model.BOOK_FOLDER_NAMING_FORMAT
: The format to use to name the folders where the books are stored. You can use the following placeholders:{authorFirst}
,{author}
,{title}
,{serie}
.BOOK_FILE_NAMING_FORMAT
: The format to use to name the files where the books are stored. You can use the following placeholders:{serie}
,{serieIndex}
,{title}
.KOBO_PROXY_USE_DEV
: If set to1
, the kobo proxy will be used in development.KOBO_PROXY_USE_EVERYWHERE
: If set to1
, the kobo proxy will be used everywhere and all request will be forwarded to the original store.KOBO_PROXY_ENABLED
: If set to0
, the kobo proxy will be disabled.ALLOW_BOOK_RELOCATION
: If set to0
, the books will not be moved to the correct folder when added to the library. This is useful if you want to manage the folder structure yourself.