Skip to content

Commit 4802485

Browse files
authored
Clarify readme. (#298)
1 parent 747de5c commit 4802485

File tree

1 file changed

+6
-36
lines changed

1 file changed

+6
-36
lines changed

README.md

Lines changed: 6 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,9 @@
22

33
[![Docker Hub](https://img.shields.io/badge/Docker-DockerHub-blue?style=flat-square)](https://hub.docker.com/r/archmonger/conreq) [![GitHub Container Registry](https://img.shields.io/badge/Docker-GitHub-blue?style=flat-square)](https://github.com/Archmonger/Conreq/pkgs/container/conreq) [![Discord](https://img.shields.io/discord/440067432552595457?style=flat-square&label=Discord&logo=discord)](https://discord.gg/gQhGZzEjmX "Chat with the community and get realtime support!")
44

5-
## Notice - July 11th, 2022
5+
Conreq is a content requesting platform that allows users to request content from Sonarr/Radarr. It is designed to be a user-friendly interface for requesting content.
6+
7+
## Notice
68

79
Conreq is currently undergoing an architectural shift. The biggest change will be the addditional of an app store for adding/removing features to Conreq.
810

@@ -18,41 +20,9 @@ Want to join the community or have a question? Join us on [Discord](https://disc
1820

1921
Looking for more info? Are you a developer and want to contribute? Check out our [Documentation](https://archmonger.github.io/Conreq/)!
2022

21-
## Installation (Production Environment)
22-
23-
Install through [Unraid Community Applications](https://squidly271.github.io/forumpost0.html), or [Docker](https://archmonger.github.io/Conreq/latest/install/docker/).
24-
25-
Here's a list of all available environment variables:
26-
27-
```nginx
28-
# General Settings
29-
TZ = America/Los_Angeles # default: UTC (Timezone for log files, in "TZ Database" format)
30-
BASE_URL = requests # default: None
31-
APP_NAME = RequestCentral # default: Conreq
32-
APP_DESCRIPTION = Get yo stuff! # default: Content Requesting
33-
ARR_REFRESH_INTERNAL = */15 # default: */1 (Cron minutes for Sonarr/Radarr library refresh)
34-
LOG_LEVEL = ERROR # default: WARNING
35-
CONREQ_ENV_PREFIX = CONREQ # default: None
36-
37-
# Data Storage
38-
DATA_DIR = /example/directory # default: /config (Defaults to "data" outside of docker)
39-
DB_ENGINE = MYSQL # default: SQLITE3
40-
MYSQL_CONFIG_FILE = /config/mysql.cnf # default: None
41-
42-
# Security
43-
SSL_SECURITY = True # default: False (True enables advanced SSL security features)
44-
PWNED_VALIDATOR = False # default: True (False disables checking for compromised passwords)
45-
ALLOWED_HOST = 192.168.0.199 # default: * (Comma separated list. Asterisk allows all hosts.)
46-
TRUSTED_ORIGINS = https://*.example.com # default: None (Comma separated list. Required to be set if using https.)
47-
DEBUG = True # default: False (Only enable this during development or testing.)
48-
49-
# Email (Required for password reset features)
50-
EMAIL_USE_TLS = False # default: True
51-
EMAIL_PORT = 587 # default: None
52-
EMAIL_HOST = smtp.gmail.com # default: None
53-
EMAIL_HOST_USER = [email protected] # default: None
54-
EMAIL_HOST_PASSWORD = dogmemes123 # default: None
55-
```
23+
## Installation
24+
25+
Install through [Docker](https://archmonger.github.io/Conreq/latest/install/docker/) or [Windows NSSM](https://archmonger.github.io/Conreq/latest/install/nssm/).
5626

5727
# Screenshots
5828

0 commit comments

Comments
 (0)