From c2df20e6adf191600ed3bbe95c9c12077572b569 Mon Sep 17 00:00:00 2001 From: zyachel Date: Sat, 10 Dec 2022 19:52:39 +0530 Subject: [PATCH] docs(.env): update .env some variables aren't optional anymore fix https://github.com/zyachel/libremdb/issues/22 --- .env.local.example | 29 ++++++++++++++++++++--------- 1 file changed, 20 insertions(+), 9 deletions(-) diff --git a/.env.local.example b/.env.local.example index 551eced..1fb22b1 100644 --- a/.env.local.example +++ b/.env.local.example @@ -1,18 +1,29 @@ -### required fields +################################################################################ +### PLEASE FILL/ENABLE REQUIRED VARS AT LEAST BEFORE RUNNING THE APPLICATION ### +################################################################################ + +################################################################################ +### 1. REQUIRED VARS(site may not work as expected without these). +################################################################################ ## used for meta tags. e.g: 'https://libremdb.iket.me'. don't add end slash. NEXT_PUBLIC_URL= +## used when fetching data from IMDb. not adding these could result in not getting any response. +## example useragent header: 'Mozilla/5.0 (X11; Linux x86_64; rv:108.0) Gecko/20100101 Firefox/108.0' +AXIOS_USERAGENT= +## example accept header: 'text/html,application/xhtml+xml,application/xml;q=0.9,image/avif,image/webp,*/*;q=0.8' +AXIOS_ACCEPT= -### optional fields. modify according to your needs. +################################################################################ +### 2. OPTIONAL VARS(enabling these is encouraged) +################################################################################ +## for forcing a certain language for data we get from imdb. Useful when you don't want your IP to determine the preferred language. +# AXIOS_LANGUAGE='en-US,en;q=0.5' ## comment it out if you wish to enable nextjs stats collection. more at https://nextjs.org/telemetry NEXT_TELEMETRY_DISABLED=1 -## default useragent for requesting data from imdb is 'axios/0.27.2' -# AXIOS_USERAGENT= -## default accept header is 'application/json, text/plain, */*' -# AXIOS_ACCEPT= -## for forcing a certain language for data we get from imdb -# AXIOS_LANGUAGE='en-US,en;q=0.5' -### REDIS +################################################################################ +### 3. REDIS CONFIG(optional if you don't need redis) +################################################################################ ## if you want to use redis to speed up the media proxy, set this to true # USE_REDIS=true ## for docker, just set the domain to the container name, default is 'libremdb_redis'