diff --git a/compose/web_service/nginx_uvicorn/.env b/compose/web_service/nginx_uvicorn/.env new file mode 100644 index 0000000..7818bf2 --- /dev/null +++ b/compose/web_service/nginx_uvicorn/.env @@ -0,0 +1,11 @@ +PROJECT_DIR=django_sample +WORKERS=4 +GUNICORN_PORT=8000 +REQUIREMENTS=./requirements.txt +PROJECT_NAME=django_sample +LOG_DRIVER=json-file +LOG_OPT_MAXF=5 +LOG_OPT_MAXS=100m +CELERY_BROKER_URL=redis://redis:6379/3 +FLOWER_ID=admin +FLOWER_PWD=admin \ No newline at end of file diff --git a/compose/web_service/nginx_uvicorn/docker-compose.yml b/compose/web_service/nginx_uvicorn/docker-compose.yml new file mode 100644 index 0000000..b881dcf --- /dev/null +++ b/compose/web_service/nginx_uvicorn/docker-compose.yml @@ -0,0 +1,158 @@ +services: + webserver: + build: ../../../docker/nginx/ + logging: + driver: "${LOG_DRIVER}" + options: + max-file: "${LOG_OPT_MAXF}" + max-size: "${LOG_OPT_MAXS}" + working_dir: /application + container_name: nginx-uvicorn-webserver + volumes: + - ../../../www:/www + - ../../../script/:/script/ + - ../../../config/web-server/nginx/gunicorn/conf.d/:/etc/nginx/conf.d/ + - ../../../config/web-server/nginx/gunicorn/nginx_conf/nginx.conf:/etc/nginx/nginx.conf + - ../../../config/web-server/nginx/gunicorn/proxy_params/proxy_params:/etc/nginx/proxy_params + - ./ssl/certs/:/etc/ssl/certs/ + - ./ssl/letsencrypt/:/etc/letsencrypt/ + - ../../../log/:/log/ + - ../../../script/logrotate/nginx/nginx:/etc/logrotate.d/nginx + ports: + - 80:80 + - 443:443 + environment: + TZ: "Asia/Seoul" + restart: always + + uvicorn-app: + build: ../../../docker/gunicorn/ + logging: + driver: "${LOG_DRIVER}" + options: + max-file: "${LOG_OPT_MAXF}" + max-size: "${LOG_OPT_MAXS}" + working_dir: /www/${PROJECT_DIR} + container_name: uvicorn-app + volumes: + - ../../../www:/www + - ../../../log:/log + - ../../../config/app-server/uvicorn/:/uvicorn + - ../../../script/logrotate/uvicorn/uvicorn:/etc/logrotate.d/uvicorn + command: bash -c "poetry config virtualenvs.create false && poetry install --no-root --without test && gunicorn -c /uvicorn/gunicorn_uvicorn.conf.py" + environment: + TZ: "Asia/Seoul" + restart: always + + celery: + build: ../../../docker/gunicorn/ + logging: + driver: "${LOG_DRIVER}" + options: + max-file: "${LOG_OPT_MAXF}" + max-size: "${LOG_OPT_MAXS}" + working_dir: /www/${PROJECT_DIR} + container_name: celery-app + volumes: + - ../../../www:/www + - ../../../log:/log + - ../../../script/logrotate/uvicorn/celery/uvicorn-celery:/etc/logrotate.d/uvicorn-celery + command: bash -c "poetry config virtualenvs.create false && \ + poetry install --no-root && \ + celery -A config worker \ + --loglevel=INFO \ + --logfile=/log/uvicorn/celery/worker-%n%I.log " + environment: + TZ: "Asia/Seoul" + restart: always + depends_on: + - redis + - gunicorn-uvicorn-app + profiles: + - celery + + celery-beat: + build: ../../../docker/gunicorn/ + logging: + driver: "${LOG_DRIVER}" + options: + max-file: "${LOG_OPT_MAXF}" + max-size: "${LOG_OPT_MAXS}" + working_dir: /www/${PROJECT_DIR} + container_name: celerybeat-app + volumes: + - ../../../www:/www + - ../../../log:/log + - ../../../script/logrotate/uvicorn/celerybeat/uvicorn-celerybeat:/etc/logrotate.d/uvicorn-celerybeat + command: bash -c "poetry config virtualenvs.create false && \ + poetry install --no-root && \ + celery -A config beat \ + --loglevel=INFO \ + --scheduler django_celery_beat.schedulers:DatabaseScheduler \ + --logfile=/log/uvicorn/celerybeat/celerybeat.log " + environment: + TZ: "Asia/Seoul" + restart: always + depends_on: + - celery + profiles: + - celery + + flower: + image: mher/flower:master + logging: + driver: "${LOG_DRIVER}" + options: + max-file: "${LOG_OPT_MAXF}" + max-size: "${LOG_OPT_MAXS}" + container_name: flower + ports: + - "5555:5555" + environment: + - CELERY_BROKER_URL=${CELERY_BROKER_URL} + - FLOWER_BASIC_AUTH=${FLOWER_ID}:${FLOWER_PWD} + restart: always + depends_on: + - celery-beat + profiles: + - celery + + redis: + image: redis:latest + logging: + driver: "${LOG_DRIVER}" + options: + max-file: "${LOG_OPT_MAXF}" + max-size: "${LOG_OPT_MAXS}" + container_name: redis_db + # ports: + # - 6379:6379 + volumes: + - ./redis/data:/data + - ./redis/conf/:/usr/local/etc/redis/ + labels: + - "name=redis" + - "mode=standalone" + environment: + TZ: "Asia/Seoul" + restart: always + command: redis-server /usr/local/etc/redis/redis.conf + + redis-stats: + image: insready/redis-stat:latest + logging: + driver: "${LOG_DRIVER}" + options: + max-file: "${LOG_OPT_MAXF}" + max-size: "${LOG_OPT_MAXS}" + container_name: redis-stats + ports: + - 63790:63790 + command: ["--verbose", "--server", "redis:6379"] + environment: + TZ: "Asia/Seoul" + depends_on: + - redis + restart: always + profiles: + - redis diff --git a/compose/web_service/nginx_uvicorn/redis/conf/redis.conf b/compose/web_service/nginx_uvicorn/redis/conf/redis.conf new file mode 100644 index 0000000..1547894 --- /dev/null +++ b/compose/web_service/nginx_uvicorn/redis/conf/redis.conf @@ -0,0 +1,2277 @@ +# Redis configuration file example. +# +# Note that in order to read the configuration file, Redis must be +# started with the file path as first argument: +# +# ./redis-server /path/to/redis.conf + +# Note on units: when memory size is needed, it is possible to specify +# it in the usual form of 1k 5GB 4M and so forth: +# +# 1k => 1000 bytes +# 1kb => 1024 bytes +# 1m => 1000000 bytes +# 1mb => 1024*1024 bytes +# 1g => 1000000000 bytes +# 1gb => 1024*1024*1024 bytes +# +# units are case insensitive so 1GB 1Gb 1gB are all the same. + +################################## INCLUDES ################################### + +# Include one or more other config files here. This is useful if you +# have a standard template that goes to all Redis servers but also need +# to customize a few per-server settings. Include files can include +# other files, so use this wisely. +# +# Note that option "include" won't be rewritten by command "CONFIG REWRITE" +# from admin or Redis Sentinel. Since Redis always uses the last processed +# line as value of a configuration directive, you'd better put includes +# at the beginning of this file to avoid overwriting config change at runtime. +# +# If instead you are interested in using includes to override configuration +# options, it is better to use include as the last line. +# +# Included paths may contain wildcards. All files matching the wildcards will +# be included in alphabetical order. +# Note that if an include path contains a wildcards but no files match it when +# the server is started, the include statement will be ignored and no error will +# be emitted. It is safe, therefore, to include wildcard files from empty +# directories. +# +# include /path/to/local.conf +# include /path/to/other.conf +# include /path/to/fragments/*.conf +# + +################################## MODULES ##################################### + +# Load modules at startup. If the server is not able to load modules +# it will abort. It is possible to use multiple loadmodule directives. +# +# loadmodule /path/to/my_module.so +# loadmodule /path/to/other_module.so + +################################## NETWORK ##################################### + +# By default, if no "bind" configuration directive is specified, Redis listens +# for connections from all available network interfaces on the host machine. +# It is possible to listen to just one or multiple selected interfaces using +# the "bind" configuration directive, followed by one or more IP addresses. +# Each address can be prefixed by "-", which means that redis will not fail to +# start if the address is not available. Being not available only refers to +# addresses that does not correspond to any network interface. Addresses that +# are already in use will always fail, and unsupported protocols will always BE +# silently skipped. +# +# Examples: +# +# bind 192.168.1.100 10.0.0.1 # listens on two specific IPv4 addresses +# bind 127.0.0.1 ::1 # listens on loopback IPv4 and IPv6 +# bind * -::* # like the default, all available interfaces +# +# ~~~ WARNING ~~~ If the computer running Redis is directly exposed to the +# internet, binding to all the interfaces is dangerous and will expose the +# instance to everybody on the internet. So by default we uncomment the +# following bind directive, that will force Redis to listen only on the +# IPv4 and IPv6 (if available) loopback interface addresses (this means Redis +# will only be able to accept client connections from the same host that it is +# running on). +# +# IF YOU ARE SURE YOU WANT YOUR INSTANCE TO LISTEN TO ALL THE INTERFACES +# COMMENT OUT THE FOLLOWING LINE. +# +# You will also need to set a password unless you explicitly disable protected +# mode. +# ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ +#bind 127.0.0.1 -::1 +bind 0.0.0.0 + +# By default, outgoing connections (from replica to master, from Sentinel to +# instances, cluster bus, etc.) are not bound to a specific local address. In +# most cases, this means the operating system will handle that based on routing +# and the interface through which the connection goes out. +# +# Using bind-source-addr it is possible to configure a specific address to bind +# to, which may also affect how the connection gets routed. +# +# Example: +# +# bind-source-addr 10.0.0.1 + +# Protected mode is a layer of security protection, in order to avoid that +# Redis instances left open on the internet are accessed and exploited. +# +# When protected mode is on and the default user has no password, the server +# only accepts local connections from the IPv4 address (127.0.0.1), IPv6 address +# (::1) or Unix domain sockets. +# +# By default protected mode is enabled. You should disable it only if +# you are sure you want clients from other hosts to connect to Redis +# even if no authentication is configured. +protected-mode no + +# Redis uses default hardened security configuration directives to reduce the +# attack surface on innocent users. Therefore, several sensitive configuration +# directives are immutable, and some potentially-dangerous commands are blocked. +# +# Configuration directives that control files that Redis writes to (e.g., 'dir' +# and 'dbfilename') and that aren't usually modified during runtime +# are protected by making them immutable. +# +# Commands that can increase the attack surface of Redis and that aren't usually +# called by users are blocked by default. +# +# These can be exposed to either all connections or just local ones by setting +# each of the configs listed below to either of these values: +# +# no - Block for any connection (remain immutable) +# yes - Allow for any connection (no protection) +# local - Allow only for local connections. Ones originating from the +# IPv4 address (127.0.0.1), IPv6 address (::1) or Unix domain sockets. +# +# enable-protected-configs no +# enable-debug-command no +# enable-module-command no + +# Accept connections on the specified port, default is 6379 (IANA #815344). +# If port 0 is specified Redis will not listen on a TCP socket. +port 6379 + +# TCP listen() backlog. +# +# In high requests-per-second environments you need a high backlog in order +# to avoid slow clients connection issues. Note that the Linux kernel +# will silently truncate it to the value of /proc/sys/net/core/somaxconn so +# make sure to raise both the value of somaxconn and tcp_max_syn_backlog +# in order to get the desired effect. +tcp-backlog 511 + +# Unix socket. +# +# Specify the path for the Unix socket that will be used to listen for +# incoming connections. There is no default, so Redis will not listen +# on a unix socket when not specified. +# +# unixsocket /run/redis.sock +# unixsocketperm 700 + +# Close the connection after a client is idle for N seconds (0 to disable) +timeout 0 + +# TCP keepalive. +# +# If non-zero, use SO_KEEPALIVE to send TCP ACKs to clients in absence +# of communication. This is useful for two reasons: +# +# 1) Detect dead peers. +# 2) Force network equipment in the middle to consider the connection to be +# alive. +# +# On Linux, the specified value (in seconds) is the period used to send ACKs. +# Note that to close the connection the double of the time is needed. +# On other kernels the period depends on the kernel configuration. +# +# A reasonable value for this option is 300 seconds, which is the new +# Redis default starting with Redis 3.2.1. +tcp-keepalive 300 + +# Apply OS-specific mechanism to mark the listening socket with the specified +# ID, to support advanced routing and filtering capabilities. +# +# On Linux, the ID represents a connection mark. +# On FreeBSD, the ID represents a socket cookie ID. +# On OpenBSD, the ID represents a route table ID. +# +# The default value is 0, which implies no marking is required. +# socket-mark-id 0 + +################################# TLS/SSL ##################################### + +# By default, TLS/SSL is disabled. To enable it, the "tls-port" configuration +# directive can be used to define TLS-listening ports. To enable TLS on the +# default port, use: +# +# port 0 +# tls-port 6379 + +# Configure a X.509 certificate and private key to use for authenticating the +# server to connected clients, masters or cluster peers. These files should be +# PEM formatted. +# +# tls-cert-file redis.crt +# tls-key-file redis.key +# +# If the key file is encrypted using a passphrase, it can be included here +# as well. +# +# tls-key-file-pass secret + +# Normally Redis uses the same certificate for both server functions (accepting +# connections) and client functions (replicating from a master, establishing +# cluster bus connections, etc.). +# +# Sometimes certificates are issued with attributes that designate them as +# client-only or server-only certificates. In that case it may be desired to use +# different certificates for incoming (server) and outgoing (client) +# connections. To do that, use the following directives: +# +# tls-client-cert-file client.crt +# tls-client-key-file client.key +# +# If the key file is encrypted using a passphrase, it can be included here +# as well. +# +# tls-client-key-file-pass secret + +# Configure a DH parameters file to enable Diffie-Hellman (DH) key exchange, +# required by older versions of OpenSSL (<3.0). Newer versions do not require +# this configuration and recommend against it. +# +# tls-dh-params-file redis.dh + +# Configure a CA certificate(s) bundle or directory to authenticate TLS/SSL +# clients and peers. Redis requires an explicit configuration of at least one +# of these, and will not implicitly use the system wide configuration. +# +# tls-ca-cert-file ca.crt +# tls-ca-cert-dir /etc/ssl/certs + +# By default, clients (including replica servers) on a TLS port are required +# to authenticate using valid client side certificates. +# +# If "no" is specified, client certificates are not required and not accepted. +# If "optional" is specified, client certificates are accepted and must be +# valid if provided, but are not required. +# +# tls-auth-clients no +# tls-auth-clients optional + +# By default, a Redis replica does not attempt to establish a TLS connection +# with its master. +# +# Use the following directive to enable TLS on replication links. +# +# tls-replication yes + +# By default, the Redis Cluster bus uses a plain TCP connection. To enable +# TLS for the bus protocol, use the following directive: +# +# tls-cluster yes + +# By default, only TLSv1.2 and TLSv1.3 are enabled and it is highly recommended +# that older formally deprecated versions are kept disabled to reduce the attack surface. +# You can explicitly specify TLS versions to support. +# Allowed values are case insensitive and include "TLSv1", "TLSv1.1", "TLSv1.2", +# "TLSv1.3" (OpenSSL >= 1.1.1) or any combination. +# To enable only TLSv1.2 and TLSv1.3, use: +# +# tls-protocols "TLSv1.2 TLSv1.3" + +# Configure allowed ciphers. See the ciphers(1ssl) manpage for more information +# about the syntax of this string. +# +# Note: this configuration applies only to <= TLSv1.2. +# +# tls-ciphers DEFAULT:!MEDIUM + +# Configure allowed TLSv1.3 ciphersuites. See the ciphers(1ssl) manpage for more +# information about the syntax of this string, and specifically for TLSv1.3 +# ciphersuites. +# +# tls-ciphersuites TLS_CHACHA20_POLY1305_SHA256 + +# When choosing a cipher, use the server's preference instead of the client +# preference. By default, the server follows the client's preference. +# +# tls-prefer-server-ciphers yes + +# By default, TLS session caching is enabled to allow faster and less expensive +# reconnections by clients that support it. Use the following directive to disable +# caching. +# +# tls-session-caching no + +# Change the default number of TLS sessions cached. A zero value sets the cache +# to unlimited size. The default size is 20480. +# +# tls-session-cache-size 5000 + +# Change the default timeout of cached TLS sessions. The default timeout is 300 +# seconds. +# +# tls-session-cache-timeout 60 + +################################# GENERAL ##################################### + +# By default Redis does not run as a daemon. Use 'yes' if you need it. +# Note that Redis will write a pid file in /var/run/redis.pid when daemonized. +# When Redis is supervised by upstart or systemd, this parameter has no impact. +daemonize no + +# If you run Redis from upstart or systemd, Redis can interact with your +# supervision tree. Options: +# supervised no - no supervision interaction +# supervised upstart - signal upstart by putting Redis into SIGSTOP mode +# requires "expect stop" in your upstart job config +# supervised systemd - signal systemd by writing READY=1 to $NOTIFY_SOCKET +# on startup, and updating Redis status on a regular +# basis. +# supervised auto - detect upstart or systemd method based on +# UPSTART_JOB or NOTIFY_SOCKET environment variables +# Note: these supervision methods only signal "process is ready." +# They do not enable continuous pings back to your supervisor. +# +# The default is "no". To run under upstart/systemd, you can simply uncomment +# the line below: +# +# supervised auto + +# If a pid file is specified, Redis writes it where specified at startup +# and removes it at exit. +# +# When the server runs non daemonized, no pid file is created if none is +# specified in the configuration. When the server is daemonized, the pid file +# is used even if not specified, defaulting to "/var/run/redis.pid". +# +# Creating a pid file is best effort: if Redis is not able to create it +# nothing bad happens, the server will start and run normally. +# +# Note that on modern Linux systems "/run/redis.pid" is more conforming +# and should be used instead. +pidfile /var/run/redis_6379.pid + +# Specify the server verbosity level. +# This can be one of: +# debug (a lot of information, useful for development/testing) +# verbose (many rarely useful info, but not a mess like the debug level) +# notice (moderately verbose, what you want in production probably) +# warning (only very important / critical messages are logged) +loglevel notice + +# Specify the log file name. Also the empty string can be used to force +# Redis to log on the standard output. Note that if you use standard +# output for logging but daemonize, logs will be sent to /dev/null +logfile "" + +# To enable logging to the system logger, just set 'syslog-enabled' to yes, +# and optionally update the other syslog parameters to suit your needs. +# syslog-enabled no + +# Specify the syslog identity. +# syslog-ident redis + +# Specify the syslog facility. Must be USER or between LOCAL0-LOCAL7. +# syslog-facility local0 + +# To disable the built in crash log, which will possibly produce cleaner core +# dumps when they are needed, uncomment the following: +# +# crash-log-enabled no + +# To disable the fast memory check that's run as part of the crash log, which +# will possibly let redis terminate sooner, uncomment the following: +# +# crash-memcheck-enabled no + +# Set the number of databases. The default database is DB 0, you can select +# a different one on a per-connection basis using SELECT where +# dbid is a number between 0 and 'databases'-1 +databases 16 + +# By default Redis shows an ASCII art logo only when started to log to the +# standard output and if the standard output is a TTY and syslog logging is +# disabled. Basically this means that normally a logo is displayed only in +# interactive sessions. +# +# However it is possible to force the pre-4.0 behavior and always show a +# ASCII art logo in startup logs by setting the following option to yes. +always-show-logo no + +# By default, Redis modifies the process title (as seen in 'top' and 'ps') to +# provide some runtime information. It is possible to disable this and leave +# the process name as executed by setting the following to no. +set-proc-title yes + +# When changing the process title, Redis uses the following template to construct +# the modified title. +# +# Template variables are specified in curly brackets. The following variables are +# supported: +# +# {title} Name of process as executed if parent, or type of child process. +# {listen-addr} Bind address or '*' followed by TCP or TLS port listening on, or +# Unix socket if only that's available. +# {server-mode} Special mode, i.e. "[sentinel]" or "[cluster]". +# {port} TCP port listening on, or 0. +# {tls-port} TLS port listening on, or 0. +# {unixsocket} Unix domain socket listening on, or "". +# {config-file} Name of configuration file used. +# +proc-title-template "{title} {listen-addr} {server-mode}" + +################################ SNAPSHOTTING ################################ + +# Save the DB to disk. +# +# save [ ...] +# +# Redis will save the DB if the given number of seconds elapsed and it +# surpassed the given number of write operations against the DB. +# +# Snapshotting can be completely disabled with a single empty string argument +# as in following example: +# +# save "" +# +# Unless specified otherwise, by default Redis will save the DB: +# * After 3600 seconds (an hour) if at least 1 change was performed +# * After 300 seconds (5 minutes) if at least 100 changes were performed +# * After 60 seconds if at least 10000 changes were performed +# +# You can set these explicitly by uncommenting the following line. +# +# save 3600 1 300 100 60 10000 + +# By default Redis will stop accepting writes if RDB snapshots are enabled +# (at least one save point) and the latest background save failed. +# This will make the user aware (in a hard way) that data is not persisting +# on disk properly, otherwise chances are that no one will notice and some +# disaster will happen. +# +# If the background saving process will start working again Redis will +# automatically allow writes again. +# +# However if you have setup your proper monitoring of the Redis server +# and persistence, you may want to disable this feature so that Redis will +# continue to work as usual even if there are problems with disk, +# permissions, and so forth. +stop-writes-on-bgsave-error yes + +# Compress string objects using LZF when dump .rdb databases? +# By default compression is enabled as it's almost always a win. +# If you want to save some CPU in the saving child set it to 'no' but +# the dataset will likely be bigger if you have compressible values or keys. +rdbcompression yes + +# Since version 5 of RDB a CRC64 checksum is placed at the end of the file. +# This makes the format more resistant to corruption but there is a performance +# hit to pay (around 10%) when saving and loading RDB files, so you can disable it +# for maximum performances. +# +# RDB files created with checksum disabled have a checksum of zero that will +# tell the loading code to skip the check. +rdbchecksum yes + +# Enables or disables full sanitization checks for ziplist and listpack etc when +# loading an RDB or RESTORE payload. This reduces the chances of a assertion or +# crash later on while processing commands. +# Options: +# no - Never perform full sanitization +# yes - Always perform full sanitization +# clients - Perform full sanitization only for user connections. +# Excludes: RDB files, RESTORE commands received from the master +# connection, and client connections which have the +# skip-sanitize-payload ACL flag. +# The default should be 'clients' but since it currently affects cluster +# resharding via MIGRATE, it is temporarily set to 'no' by default. +# +# sanitize-dump-payload no + +# The filename where to dump the DB +dbfilename dump.rdb + +# Remove RDB files used by replication in instances without persistence +# enabled. By default this option is disabled, however there are environments +# where for regulations or other security concerns, RDB files persisted on +# disk by masters in order to feed replicas, or stored on disk by replicas +# in order to load them for the initial synchronization, should be deleted +# ASAP. Note that this option ONLY WORKS in instances that have both AOF +# and RDB persistence disabled, otherwise is completely ignored. +# +# An alternative (and sometimes better) way to obtain the same effect is +# to use diskless replication on both master and replicas instances. However +# in the case of replicas, diskless is not always an option. +rdb-del-sync-files no + +# The working directory. +# +# The DB will be written inside this directory, with the filename specified +# above using the 'dbfilename' configuration directive. +# +# The Append Only File will also be created inside this directory. +# +# Note that you must specify a directory here, not a file name. +dir ./ + +################################# REPLICATION ################################# + +# Master-Replica replication. Use replicaof to make a Redis instance a copy of +# another Redis server. A few things to understand ASAP about Redis replication. +# +# +------------------+ +---------------+ +# | Master | ---> | Replica | +# | (receive writes) | | (exact copy) | +# +------------------+ +---------------+ +# +# 1) Redis replication is asynchronous, but you can configure a master to +# stop accepting writes if it appears to be not connected with at least +# a given number of replicas. +# 2) Redis replicas are able to perform a partial resynchronization with the +# master if the replication link is lost for a relatively small amount of +# time. You may want to configure the replication backlog size (see the next +# sections of this file) with a sensible value depending on your needs. +# 3) Replication is automatic and does not need user intervention. After a +# network partition replicas automatically try to reconnect to masters +# and resynchronize with them. +# +# replicaof + +# If the master is password protected (using the "requirepass" configuration +# directive below) it is possible to tell the replica to authenticate before +# starting the replication synchronization process, otherwise the master will +# refuse the replica request. +# +# masterauth +# +# However this is not enough if you are using Redis ACLs (for Redis version +# 6 or greater), and the default user is not capable of running the PSYNC +# command and/or other commands needed for replication. In this case it's +# better to configure a special user to use with replication, and specify the +# masteruser configuration as such: +# +# masteruser +# +# When masteruser is specified, the replica will authenticate against its +# master using the new AUTH form: AUTH . + +# When a replica loses its connection with the master, or when the replication +# is still in progress, the replica can act in two different ways: +# +# 1) if replica-serve-stale-data is set to 'yes' (the default) the replica will +# still reply to client requests, possibly with out of date data, or the +# data set may just be empty if this is the first synchronization. +# +# 2) If replica-serve-stale-data is set to 'no' the replica will reply with error +# "MASTERDOWN Link with MASTER is down and replica-serve-stale-data is set to 'no'" +# to all data access commands, excluding commands such as: +# INFO, REPLICAOF, AUTH, SHUTDOWN, REPLCONF, ROLE, CONFIG, SUBSCRIBE, +# UNSUBSCRIBE, PSUBSCRIBE, PUNSUBSCRIBE, PUBLISH, PUBSUB, COMMAND, POST, +# HOST and LATENCY. +# +replica-serve-stale-data yes + +# You can configure a replica instance to accept writes or not. Writing against +# a replica instance may be useful to store some ephemeral data (because data +# written on a replica will be easily deleted after resync with the master) but +# may also cause problems if clients are writing to it because of a +# misconfiguration. +# +# Since Redis 2.6 by default replicas are read-only. +# +# Note: read only replicas are not designed to be exposed to untrusted clients +# on the internet. It's just a protection layer against misuse of the instance. +# Still a read only replica exports by default all the administrative commands +# such as CONFIG, DEBUG, and so forth. To a limited extent you can improve +# security of read only replicas using 'rename-command' to shadow all the +# administrative / dangerous commands. +replica-read-only yes + +# Replication SYNC strategy: disk or socket. +# +# New replicas and reconnecting replicas that are not able to continue the +# replication process just receiving differences, need to do what is called a +# "full synchronization". An RDB file is transmitted from the master to the +# replicas. +# +# The transmission can happen in two different ways: +# +# 1) Disk-backed: The Redis master creates a new process that writes the RDB +# file on disk. Later the file is transferred by the parent +# process to the replicas incrementally. +# 2) Diskless: The Redis master creates a new process that directly writes the +# RDB file to replica sockets, without touching the disk at all. +# +# With disk-backed replication, while the RDB file is generated, more replicas +# can be queued and served with the RDB file as soon as the current child +# producing the RDB file finishes its work. With diskless replication instead +# once the transfer starts, new replicas arriving will be queued and a new +# transfer will start when the current one terminates. +# +# When diskless replication is used, the master waits a configurable amount of +# time (in seconds) before starting the transfer in the hope that multiple +# replicas will arrive and the transfer can be parallelized. +# +# With slow disks and fast (large bandwidth) networks, diskless replication +# works better. +repl-diskless-sync yes + +# When diskless replication is enabled, it is possible to configure the delay +# the server waits in order to spawn the child that transfers the RDB via socket +# to the replicas. +# +# This is important since once the transfer starts, it is not possible to serve +# new replicas arriving, that will be queued for the next RDB transfer, so the +# server waits a delay in order to let more replicas arrive. +# +# The delay is specified in seconds, and by default is 5 seconds. To disable +# it entirely just set it to 0 seconds and the transfer will start ASAP. +repl-diskless-sync-delay 5 + +# When diskless replication is enabled with a delay, it is possible to let +# the replication start before the maximum delay is reached if the maximum +# number of replicas expected have connected. Default of 0 means that the +# maximum is not defined and Redis will wait the full delay. +repl-diskless-sync-max-replicas 0 + +# ----------------------------------------------------------------------------- +# WARNING: RDB diskless load is experimental. Since in this setup the replica +# does not immediately store an RDB on disk, it may cause data loss during +# failovers. RDB diskless load + Redis modules not handling I/O reads may also +# cause Redis to abort in case of I/O errors during the initial synchronization +# stage with the master. Use only if you know what you are doing. +# ----------------------------------------------------------------------------- +# +# Replica can load the RDB it reads from the replication link directly from the +# socket, or store the RDB to a file and read that file after it was completely +# received from the master. +# +# In many cases the disk is slower than the network, and storing and loading +# the RDB file may increase replication time (and even increase the master's +# Copy on Write memory and replica buffers). +# However, parsing the RDB file directly from the socket may mean that we have +# to flush the contents of the current database before the full rdb was +# received. For this reason we have the following options: +# +# "disabled" - Don't use diskless load (store the rdb file to the disk first) +# "on-empty-db" - Use diskless load only when it is completely safe. +# "swapdb" - Keep current db contents in RAM while parsing the data directly +# from the socket. Replicas in this mode can keep serving current +# data set while replication is in progress, except for cases where +# they can't recognize master as having a data set from same +# replication history. +# Note that this requires sufficient memory, if you don't have it, +# you risk an OOM kill. +repl-diskless-load disabled + +# Master send PINGs to its replicas in a predefined interval. It's possible to +# change this interval with the repl_ping_replica_period option. The default +# value is 10 seconds. +# +# repl-ping-replica-period 10 + +# The following option sets the replication timeout for: +# +# 1) Bulk transfer I/O during SYNC, from the point of view of replica. +# 2) Master timeout from the point of view of replicas (data, pings). +# 3) Replica timeout from the point of view of masters (REPLCONF ACK pings). +# +# It is important to make sure that this value is greater than the value +# specified for repl-ping-replica-period otherwise a timeout will be detected +# every time there is low traffic between the master and the replica. The default +# value is 60 seconds. +# +# repl-timeout 60 + +# Disable TCP_NODELAY on the replica socket after SYNC? +# +# If you select "yes" Redis will use a smaller number of TCP packets and +# less bandwidth to send data to replicas. But this can add a delay for +# the data to appear on the replica side, up to 40 milliseconds with +# Linux kernels using a default configuration. +# +# If you select "no" the delay for data to appear on the replica side will +# be reduced but more bandwidth will be used for replication. +# +# By default we optimize for low latency, but in very high traffic conditions +# or when the master and replicas are many hops away, turning this to "yes" may +# be a good idea. +repl-disable-tcp-nodelay no + +# Set the replication backlog size. The backlog is a buffer that accumulates +# replica data when replicas are disconnected for some time, so that when a +# replica wants to reconnect again, often a full resync is not needed, but a +# partial resync is enough, just passing the portion of data the replica +# missed while disconnected. +# +# The bigger the replication backlog, the longer the replica can endure the +# disconnect and later be able to perform a partial resynchronization. +# +# The backlog is only allocated if there is at least one replica connected. +# +# repl-backlog-size 1mb + +# After a master has no connected replicas for some time, the backlog will be +# freed. The following option configures the amount of seconds that need to +# elapse, starting from the time the last replica disconnected, for the backlog +# buffer to be freed. +# +# Note that replicas never free the backlog for timeout, since they may be +# promoted to masters later, and should be able to correctly "partially +# resynchronize" with other replicas: hence they should always accumulate backlog. +# +# A value of 0 means to never release the backlog. +# +# repl-backlog-ttl 3600 + +# The replica priority is an integer number published by Redis in the INFO +# output. It is used by Redis Sentinel in order to select a replica to promote +# into a master if the master is no longer working correctly. +# +# A replica with a low priority number is considered better for promotion, so +# for instance if there are three replicas with priority 10, 100, 25 Sentinel +# will pick the one with priority 10, that is the lowest. +# +# However a special priority of 0 marks the replica as not able to perform the +# role of master, so a replica with priority of 0 will never be selected by +# Redis Sentinel for promotion. +# +# By default the priority is 100. +replica-priority 100 + +# The propagation error behavior controls how Redis will behave when it is +# unable to handle a command being processed in the replication stream from a master +# or processed while reading from an AOF file. Errors that occur during propagation +# are unexpected, and can cause data inconsistency. However, there are edge cases +# in earlier versions of Redis where it was possible for the server to replicate or persist +# commands that would fail on future versions. For this reason the default behavior +# is to ignore such errors and continue processing commands. +# +# If an application wants to ensure there is no data divergence, this configuration +# should be set to 'panic' instead. The value can also be set to 'panic-on-replicas' +# to only panic when a replica encounters an error on the replication stream. One of +# these two panic values will become the default value in the future once there are +# sufficient safety mechanisms in place to prevent false positive crashes. +# +# propagation-error-behavior ignore + +# Replica ignore disk write errors controls the behavior of a replica when it is +# unable to persist a write command received from its master to disk. By default, +# this configuration is set to 'no' and will crash the replica in this condition. +# It is not recommended to change this default, however in order to be compatible +# with older versions of Redis this config can be toggled to 'yes' which will just +# log a warning and execute the write command it got from the master. +# +# replica-ignore-disk-write-errors no + +# ----------------------------------------------------------------------------- +# By default, Redis Sentinel includes all replicas in its reports. A replica +# can be excluded from Redis Sentinel's announcements. An unannounced replica +# will be ignored by the 'sentinel replicas ' command and won't be +# exposed to Redis Sentinel's clients. +# +# This option does not change the behavior of replica-priority. Even with +# replica-announced set to 'no', the replica can be promoted to master. To +# prevent this behavior, set replica-priority to 0. +# +# replica-announced yes + +# It is possible for a master to stop accepting writes if there are less than +# N replicas connected, having a lag less or equal than M seconds. +# +# The N replicas need to be in "online" state. +# +# The lag in seconds, that must be <= the specified value, is calculated from +# the last ping received from the replica, that is usually sent every second. +# +# This option does not GUARANTEE that N replicas will accept the write, but +# will limit the window of exposure for lost writes in case not enough replicas +# are available, to the specified number of seconds. +# +# For example to require at least 3 replicas with a lag <= 10 seconds use: +# +# min-replicas-to-write 3 +# min-replicas-max-lag 10 +# +# Setting one or the other to 0 disables the feature. +# +# By default min-replicas-to-write is set to 0 (feature disabled) and +# min-replicas-max-lag is set to 10. + +# A Redis master is able to list the address and port of the attached +# replicas in different ways. For example the "INFO replication" section +# offers this information, which is used, among other tools, by +# Redis Sentinel in order to discover replica instances. +# Another place where this info is available is in the output of the +# "ROLE" command of a master. +# +# The listed IP address and port normally reported by a replica is +# obtained in the following way: +# +# IP: The address is auto detected by checking the peer address +# of the socket used by the replica to connect with the master. +# +# Port: The port is communicated by the replica during the replication +# handshake, and is normally the port that the replica is using to +# listen for connections. +# +# However when port forwarding or Network Address Translation (NAT) is +# used, the replica may actually be reachable via different IP and port +# pairs. The following two options can be used by a replica in order to +# report to its master a specific set of IP and port, so that both INFO +# and ROLE will report those values. +# +# There is no need to use both the options if you need to override just +# the port or the IP address. +# +# replica-announce-ip 5.5.5.5 +# replica-announce-port 1234 + +############################### KEYS TRACKING ################################# + +# Redis implements server assisted support for client side caching of values. +# This is implemented using an invalidation table that remembers, using +# a radix key indexed by key name, what clients have which keys. In turn +# this is used in order to send invalidation messages to clients. Please +# check this page to understand more about the feature: +# +# https://redis.io/topics/client-side-caching +# +# When tracking is enabled for a client, all the read only queries are assumed +# to be cached: this will force Redis to store information in the invalidation +# table. When keys are modified, such information is flushed away, and +# invalidation messages are sent to the clients. However if the workload is +# heavily dominated by reads, Redis could use more and more memory in order +# to track the keys fetched by many clients. +# +# For this reason it is possible to configure a maximum fill value for the +# invalidation table. By default it is set to 1M of keys, and once this limit +# is reached, Redis will start to evict keys in the invalidation table +# even if they were not modified, just to reclaim memory: this will in turn +# force the clients to invalidate the cached values. Basically the table +# maximum size is a trade off between the memory you want to spend server +# side to track information about who cached what, and the ability of clients +# to retain cached objects in memory. +# +# If you set the value to 0, it means there are no limits, and Redis will +# retain as many keys as needed in the invalidation table. +# In the "stats" INFO section, you can find information about the number of +# keys in the invalidation table at every given moment. +# +# Note: when key tracking is used in broadcasting mode, no memory is used +# in the server side so this setting is useless. +# +# tracking-table-max-keys 1000000 + +################################## SECURITY ################################### + +# Warning: since Redis is pretty fast, an outside user can try up to +# 1 million passwords per second against a modern box. This means that you +# should use very strong passwords, otherwise they will be very easy to break. +# Note that because the password is really a shared secret between the client +# and the server, and should not be memorized by any human, the password +# can be easily a long string from /dev/urandom or whatever, so by using a +# long and unguessable password no brute force attack will be possible. + +# Redis ACL users are defined in the following format: +# +# user ... acl rules ... +# +# For example: +# +# user worker +@list +@connection ~jobs:* on >ffa9203c493aa99 +# +# The special username "default" is used for new connections. If this user +# has the "nopass" rule, then new connections will be immediately authenticated +# as the "default" user without the need of any password provided via the +# AUTH command. Otherwise if the "default" user is not flagged with "nopass" +# the connections will start in not authenticated state, and will require +# AUTH (or the HELLO command AUTH option) in order to be authenticated and +# start to work. +# +# The ACL rules that describe what a user can do are the following: +# +# on Enable the user: it is possible to authenticate as this user. +# off Disable the user: it's no longer possible to authenticate +# with this user, however the already authenticated connections +# will still work. +# skip-sanitize-payload RESTORE dump-payload sanitization is skipped. +# sanitize-payload RESTORE dump-payload is sanitized (default). +# + Allow the execution of that command. +# May be used with `|` for allowing subcommands (e.g "+config|get") +# - Disallow the execution of that command. +# May be used with `|` for blocking subcommands (e.g "-config|set") +# +@ Allow the execution of all the commands in such category +# with valid categories are like @admin, @set, @sortedset, ... +# and so forth, see the full list in the server.c file where +# the Redis command table is described and defined. +# The special category @all means all the commands, but currently +# present in the server, and that will be loaded in the future +# via modules. +# +|first-arg Allow a specific first argument of an otherwise +# disabled command. It is only supported on commands with +# no sub-commands, and is not allowed as negative form +# like -SELECT|1, only additive starting with "+". This +# feature is deprecated and may be removed in the future. +# allcommands Alias for +@all. Note that it implies the ability to execute +# all the future commands loaded via the modules system. +# nocommands Alias for -@all. +# ~ Add a pattern of keys that can be mentioned as part of +# commands. For instance ~* allows all the keys. The pattern +# is a glob-style pattern like the one of KEYS. +# It is possible to specify multiple patterns. +# %R~ Add key read pattern that specifies which keys can be read +# from. +# %W~ Add key write pattern that specifies which keys can be +# written to. +# allkeys Alias for ~* +# resetkeys Flush the list of allowed keys patterns. +# & Add a glob-style pattern of Pub/Sub channels that can be +# accessed by the user. It is possible to specify multiple channel +# patterns. +# allchannels Alias for &* +# resetchannels Flush the list of allowed channel patterns. +# > Add this password to the list of valid password for the user. +# For example >mypass will add "mypass" to the list. +# This directive clears the "nopass" flag (see later). +# < Remove this password from the list of valid passwords. +# nopass All the set passwords of the user are removed, and the user +# is flagged as requiring no password: it means that every +# password will work against this user. If this directive is +# used for the default user, every new connection will be +# immediately authenticated with the default user without +# any explicit AUTH command required. Note that the "resetpass" +# directive will clear this condition. +# resetpass Flush the list of allowed passwords. Moreover removes the +# "nopass" status. After "resetpass" the user has no associated +# passwords and there is no way to authenticate without adding +# some password (or setting it as "nopass" later). +# reset Performs the following actions: resetpass, resetkeys, off, +# -@all. The user returns to the same state it has immediately +# after its creation. +# () Create a new selector with the options specified within the +# parentheses and attach it to the user. Each option should be +# space separated. The first character must be ( and the last +# character must be ). +# clearselectors Remove all of the currently attached selectors. +# Note this does not change the "root" user permissions, +# which are the permissions directly applied onto the +# user (outside the parentheses). +# +# ACL rules can be specified in any order: for instance you can start with +# passwords, then flags, or key patterns. However note that the additive +# and subtractive rules will CHANGE MEANING depending on the ordering. +# For instance see the following example: +# +# user alice on +@all -DEBUG ~* >somepassword +# +# This will allow "alice" to use all the commands with the exception of the +# DEBUG command, since +@all added all the commands to the set of the commands +# alice can use, and later DEBUG was removed. However if we invert the order +# of two ACL rules the result will be different: +# +# user alice on -DEBUG +@all ~* >somepassword +# +# Now DEBUG was removed when alice had yet no commands in the set of allowed +# commands, later all the commands are added, so the user will be able to +# execute everything. +# +# Basically ACL rules are processed left-to-right. +# +# The following is a list of command categories and their meanings: +# * keyspace - Writing or reading from keys, databases, or their metadata +# in a type agnostic way. Includes DEL, RESTORE, DUMP, RENAME, EXISTS, DBSIZE, +# KEYS, EXPIRE, TTL, FLUSHALL, etc. Commands that may modify the keyspace, +# key or metadata will also have `write` category. Commands that only read +# the keyspace, key or metadata will have the `read` category. +# * read - Reading from keys (values or metadata). Note that commands that don't +# interact with keys, will not have either `read` or `write`. +# * write - Writing to keys (values or metadata) +# * admin - Administrative commands. Normal applications will never need to use +# these. Includes REPLICAOF, CONFIG, DEBUG, SAVE, MONITOR, ACL, SHUTDOWN, etc. +# * dangerous - Potentially dangerous (each should be considered with care for +# various reasons). This includes FLUSHALL, MIGRATE, RESTORE, SORT, KEYS, +# CLIENT, DEBUG, INFO, CONFIG, SAVE, REPLICAOF, etc. +# * connection - Commands affecting the connection or other connections. +# This includes AUTH, SELECT, COMMAND, CLIENT, ECHO, PING, etc. +# * blocking - Potentially blocking the connection until released by another +# command. +# * fast - Fast O(1) commands. May loop on the number of arguments, but not the +# number of elements in the key. +# * slow - All commands that are not Fast. +# * pubsub - PUBLISH / SUBSCRIBE related +# * transaction - WATCH / MULTI / EXEC related commands. +# * scripting - Scripting related. +# * set - Data type: sets related. +# * sortedset - Data type: zsets related. +# * list - Data type: lists related. +# * hash - Data type: hashes related. +# * string - Data type: strings related. +# * bitmap - Data type: bitmaps related. +# * hyperloglog - Data type: hyperloglog related. +# * geo - Data type: geo related. +# * stream - Data type: streams related. +# +# For more information about ACL configuration please refer to +# the Redis web site at https://redis.io/topics/acl + +# ACL LOG +# +# The ACL Log tracks failed commands and authentication events associated +# with ACLs. The ACL Log is useful to troubleshoot failed commands blocked +# by ACLs. The ACL Log is stored in memory. You can reclaim memory with +# ACL LOG RESET. Define the maximum entry length of the ACL Log below. +acllog-max-len 128 + +# Using an external ACL file +# +# Instead of configuring users here in this file, it is possible to use +# a stand-alone file just listing users. The two methods cannot be mixed: +# if you configure users here and at the same time you activate the external +# ACL file, the server will refuse to start. +# +# The format of the external ACL user file is exactly the same as the +# format that is used inside redis.conf to describe users. +# +# aclfile /etc/redis/users.acl + +# IMPORTANT NOTE: starting with Redis 6 "requirepass" is just a compatibility +# layer on top of the new ACL system. The option effect will be just setting +# the password for the default user. Clients will still authenticate using +# AUTH as usually, or more explicitly with AUTH default +# if they follow the new protocol: both will work. +# +# The requirepass is not compatible with aclfile option and the ACL LOAD +# command, these will cause requirepass to be ignored. +# +# requirepass foobared + +# New users are initialized with restrictive permissions by default, via the +# equivalent of this ACL rule 'off resetkeys -@all'. Starting with Redis 6.2, it +# is possible to manage access to Pub/Sub channels with ACL rules as well. The +# default Pub/Sub channels permission if new users is controlled by the +# acl-pubsub-default configuration directive, which accepts one of these values: +# +# allchannels: grants access to all Pub/Sub channels +# resetchannels: revokes access to all Pub/Sub channels +# +# From Redis 7.0, acl-pubsub-default defaults to 'resetchannels' permission. +# +# acl-pubsub-default resetchannels + +# Command renaming (DEPRECATED). +# +# ------------------------------------------------------------------------ +# WARNING: avoid using this option if possible. Instead use ACLs to remove +# commands from the default user, and put them only in some admin user you +# create for administrative purposes. +# ------------------------------------------------------------------------ +# +# It is possible to change the name of dangerous commands in a shared +# environment. For instance the CONFIG command may be renamed into something +# hard to guess so that it will still be available for internal-use tools +# but not available for general clients. +# +# Example: +# +# rename-command CONFIG b840fc02d524045429941cc15f59e41cb7be6c52 +# +# It is also possible to completely kill a command by renaming it into +# an empty string: +# +# rename-command CONFIG "" +# +# Please note that changing the name of commands that are logged into the +# AOF file or transmitted to replicas may cause problems. + +################################### CLIENTS #################################### + +# Set the max number of connected clients at the same time. By default +# this limit is set to 10000 clients, however if the Redis server is not +# able to configure the process file limit to allow for the specified limit +# the max number of allowed clients is set to the current file limit +# minus 32 (as Redis reserves a few file descriptors for internal uses). +# +# Once the limit is reached Redis will close all the new connections sending +# an error 'max number of clients reached'. +# +# IMPORTANT: When Redis Cluster is used, the max number of connections is also +# shared with the cluster bus: every node in the cluster will use two +# connections, one incoming and another outgoing. It is important to size the +# limit accordingly in case of very large clusters. +# +# maxclients 10000 + +############################## MEMORY MANAGEMENT ################################ + +# Set a memory usage limit to the specified amount of bytes. +# When the memory limit is reached Redis will try to remove keys +# according to the eviction policy selected (see maxmemory-policy). +# +# If Redis can't remove keys according to the policy, or if the policy is +# set to 'noeviction', Redis will start to reply with errors to commands +# that would use more memory, like SET, LPUSH, and so on, and will continue +# to reply to read-only commands like GET. +# +# This option is usually useful when using Redis as an LRU or LFU cache, or to +# set a hard memory limit for an instance (using the 'noeviction' policy). +# +# WARNING: If you have replicas attached to an instance with maxmemory on, +# the size of the output buffers needed to feed the replicas are subtracted +# from the used memory count, so that network problems / resyncs will +# not trigger a loop where keys are evicted, and in turn the output +# buffer of replicas is full with DELs of keys evicted triggering the deletion +# of more keys, and so forth until the database is completely emptied. +# +# In short... if you have replicas attached it is suggested that you set a lower +# limit for maxmemory so that there is some free RAM on the system for replica +# output buffers (but this is not needed if the policy is 'noeviction'). +# +# maxmemory + +# MAXMEMORY POLICY: how Redis will select what to remove when maxmemory +# is reached. You can select one from the following behaviors: +# +# volatile-lru -> Evict using approximated LRU, only keys with an expire set. +# allkeys-lru -> Evict any key using approximated LRU. +# volatile-lfu -> Evict using approximated LFU, only keys with an expire set. +# allkeys-lfu -> Evict any key using approximated LFU. +# volatile-random -> Remove a random key having an expire set. +# allkeys-random -> Remove a random key, any key. +# volatile-ttl -> Remove the key with the nearest expire time (minor TTL) +# noeviction -> Don't evict anything, just return an error on write operations. +# +# LRU means Least Recently Used +# LFU means Least Frequently Used +# +# Both LRU, LFU and volatile-ttl are implemented using approximated +# randomized algorithms. +# +# Note: with any of the above policies, when there are no suitable keys for +# eviction, Redis will return an error on write operations that require +# more memory. These are usually commands that create new keys, add data or +# modify existing keys. A few examples are: SET, INCR, HSET, LPUSH, SUNIONSTORE, +# SORT (due to the STORE argument), and EXEC (if the transaction includes any +# command that requires memory). +# +# The default is: +# +# maxmemory-policy noeviction + +# LRU, LFU and minimal TTL algorithms are not precise algorithms but approximated +# algorithms (in order to save memory), so you can tune it for speed or +# accuracy. By default Redis will check five keys and pick the one that was +# used least recently, you can change the sample size using the following +# configuration directive. +# +# The default of 5 produces good enough results. 10 Approximates very closely +# true LRU but costs more CPU. 3 is faster but not very accurate. +# +# maxmemory-samples 5 + +# Eviction processing is designed to function well with the default setting. +# If there is an unusually large amount of write traffic, this value may need to +# be increased. Decreasing this value may reduce latency at the risk of +# eviction processing effectiveness +# 0 = minimum latency, 10 = default, 100 = process without regard to latency +# +# maxmemory-eviction-tenacity 10 + +# Starting from Redis 5, by default a replica will ignore its maxmemory setting +# (unless it is promoted to master after a failover or manually). It means +# that the eviction of keys will be just handled by the master, sending the +# DEL commands to the replica as keys evict in the master side. +# +# This behavior ensures that masters and replicas stay consistent, and is usually +# what you want, however if your replica is writable, or you want the replica +# to have a different memory setting, and you are sure all the writes performed +# to the replica are idempotent, then you may change this default (but be sure +# to understand what you are doing). +# +# Note that since the replica by default does not evict, it may end using more +# memory than the one set via maxmemory (there are certain buffers that may +# be larger on the replica, or data structures may sometimes take more memory +# and so forth). So make sure you monitor your replicas and make sure they +# have enough memory to never hit a real out-of-memory condition before the +# master hits the configured maxmemory setting. +# +# replica-ignore-maxmemory yes + +# Redis reclaims expired keys in two ways: upon access when those keys are +# found to be expired, and also in background, in what is called the +# "active expire key". The key space is slowly and interactively scanned +# looking for expired keys to reclaim, so that it is possible to free memory +# of keys that are expired and will never be accessed again in a short time. +# +# The default effort of the expire cycle will try to avoid having more than +# ten percent of expired keys still in memory, and will try to avoid consuming +# more than 25% of total memory and to add latency to the system. However +# it is possible to increase the expire "effort" that is normally set to +# "1", to a greater value, up to the value "10". At its maximum value the +# system will use more CPU, longer cycles (and technically may introduce +# more latency), and will tolerate less already expired keys still present +# in the system. It's a tradeoff between memory, CPU and latency. +# +# active-expire-effort 1 + +############################# LAZY FREEING #################################### + +# Redis has two primitives to delete keys. One is called DEL and is a blocking +# deletion of the object. It means that the server stops processing new commands +# in order to reclaim all the memory associated with an object in a synchronous +# way. If the key deleted is associated with a small object, the time needed +# in order to execute the DEL command is very small and comparable to most other +# O(1) or O(log_N) commands in Redis. However if the key is associated with an +# aggregated value containing millions of elements, the server can block for +# a long time (even seconds) in order to complete the operation. +# +# For the above reasons Redis also offers non blocking deletion primitives +# such as UNLINK (non blocking DEL) and the ASYNC option of FLUSHALL and +# FLUSHDB commands, in order to reclaim memory in background. Those commands +# are executed in constant time. Another thread will incrementally free the +# object in the background as fast as possible. +# +# DEL, UNLINK and ASYNC option of FLUSHALL and FLUSHDB are user-controlled. +# It's up to the design of the application to understand when it is a good +# idea to use one or the other. However the Redis server sometimes has to +# delete keys or flush the whole database as a side effect of other operations. +# Specifically Redis deletes objects independently of a user call in the +# following scenarios: +# +# 1) On eviction, because of the maxmemory and maxmemory policy configurations, +# in order to make room for new data, without going over the specified +# memory limit. +# 2) Because of expire: when a key with an associated time to live (see the +# EXPIRE command) must be deleted from memory. +# 3) Because of a side effect of a command that stores data on a key that may +# already exist. For example the RENAME command may delete the old key +# content when it is replaced with another one. Similarly SUNIONSTORE +# or SORT with STORE option may delete existing keys. The SET command +# itself removes any old content of the specified key in order to replace +# it with the specified string. +# 4) During replication, when a replica performs a full resynchronization with +# its master, the content of the whole database is removed in order to +# load the RDB file just transferred. +# +# In all the above cases the default is to delete objects in a blocking way, +# like if DEL was called. However you can configure each case specifically +# in order to instead release memory in a non-blocking way like if UNLINK +# was called, using the following configuration directives. + +lazyfree-lazy-eviction no +lazyfree-lazy-expire no +lazyfree-lazy-server-del no +replica-lazy-flush no + +# It is also possible, for the case when to replace the user code DEL calls +# with UNLINK calls is not easy, to modify the default behavior of the DEL +# command to act exactly like UNLINK, using the following configuration +# directive: + +lazyfree-lazy-user-del no + +# FLUSHDB, FLUSHALL, SCRIPT FLUSH and FUNCTION FLUSH support both asynchronous and synchronous +# deletion, which can be controlled by passing the [SYNC|ASYNC] flags into the +# commands. When neither flag is passed, this directive will be used to determine +# if the data should be deleted asynchronously. + +lazyfree-lazy-user-flush no + +################################ THREADED I/O ################################# + +# Redis is mostly single threaded, however there are certain threaded +# operations such as UNLINK, slow I/O accesses and other things that are +# performed on side threads. +# +# Now it is also possible to handle Redis clients socket reads and writes +# in different I/O threads. Since especially writing is so slow, normally +# Redis users use pipelining in order to speed up the Redis performances per +# core, and spawn multiple instances in order to scale more. Using I/O +# threads it is possible to easily speedup two times Redis without resorting +# to pipelining nor sharding of the instance. +# +# By default threading is disabled, we suggest enabling it only in machines +# that have at least 4 or more cores, leaving at least one spare core. +# Using more than 8 threads is unlikely to help much. We also recommend using +# threaded I/O only if you actually have performance problems, with Redis +# instances being able to use a quite big percentage of CPU time, otherwise +# there is no point in using this feature. +# +# So for instance if you have a four cores boxes, try to use 2 or 3 I/O +# threads, if you have a 8 cores, try to use 6 threads. In order to +# enable I/O threads use the following configuration directive: +# +# io-threads 4 +# +# Setting io-threads to 1 will just use the main thread as usual. +# When I/O threads are enabled, we only use threads for writes, that is +# to thread the write(2) syscall and transfer the client buffers to the +# socket. However it is also possible to enable threading of reads and +# protocol parsing using the following configuration directive, by setting +# it to yes: +# +# io-threads-do-reads no +# +# Usually threading reads doesn't help much. +# +# NOTE 1: This configuration directive cannot be changed at runtime via +# CONFIG SET. Also, this feature currently does not work when SSL is +# enabled. +# +# NOTE 2: If you want to test the Redis speedup using redis-benchmark, make +# sure you also run the benchmark itself in threaded mode, using the +# --threads option to match the number of Redis threads, otherwise you'll not +# be able to notice the improvements. + +############################ KERNEL OOM CONTROL ############################## + +# On Linux, it is possible to hint the kernel OOM killer on what processes +# should be killed first when out of memory. +# +# Enabling this feature makes Redis actively control the oom_score_adj value +# for all its processes, depending on their role. The default scores will +# attempt to have background child processes killed before all others, and +# replicas killed before masters. +# +# Redis supports these options: +# +# no: Don't make changes to oom-score-adj (default). +# yes: Alias to "relative" see below. +# absolute: Values in oom-score-adj-values are written as is to the kernel. +# relative: Values are used relative to the initial value of oom_score_adj when +# the server starts and are then clamped to a range of -1000 to 1000. +# Because typically the initial value is 0, they will often match the +# absolute values. +oom-score-adj no + +# When oom-score-adj is used, this directive controls the specific values used +# for master, replica and background child processes. Values range -2000 to +# 2000 (higher means more likely to be killed). +# +# Unprivileged processes (not root, and without CAP_SYS_RESOURCE capabilities) +# can freely increase their value, but not decrease it below its initial +# settings. This means that setting oom-score-adj to "relative" and setting the +# oom-score-adj-values to positive values will always succeed. +oom-score-adj-values 0 200 800 + + +#################### KERNEL transparent hugepage CONTROL ###################### + +# Usually the kernel Transparent Huge Pages control is set to "madvise" or +# or "never" by default (/sys/kernel/mm/transparent_hugepage/enabled), in which +# case this config has no effect. On systems in which it is set to "always", +# redis will attempt to disable it specifically for the redis process in order +# to avoid latency problems specifically with fork(2) and CoW. +# If for some reason you prefer to keep it enabled, you can set this config to +# "no" and the kernel global to "always". + +disable-thp yes + +############################## APPEND ONLY MODE ############################### + +# By default Redis asynchronously dumps the dataset on disk. This mode is +# good enough in many applications, but an issue with the Redis process or +# a power outage may result into a few minutes of writes lost (depending on +# the configured save points). +# +# The Append Only File is an alternative persistence mode that provides +# much better durability. For instance using the default data fsync policy +# (see later in the config file) Redis can lose just one second of writes in a +# dramatic event like a server power outage, or a single write if something +# wrong with the Redis process itself happens, but the operating system is +# still running correctly. +# +# AOF and RDB persistence can be enabled at the same time without problems. +# If the AOF is enabled on startup Redis will load the AOF, that is the file +# with the better durability guarantees. +# +# Please check https://redis.io/topics/persistence for more information. + +appendonly no + +# The base name of the append only file. +# +# Redis 7 and newer use a set of append-only files to persist the dataset +# and changes applied to it. There are two basic types of files in use: +# +# - Base files, which are a snapshot representing the complete state of the +# dataset at the time the file was created. Base files can be either in +# the form of RDB (binary serialized) or AOF (textual commands). +# - Incremental files, which contain additional commands that were applied +# to the dataset following the previous file. +# +# In addition, manifest files are used to track the files and the order in +# which they were created and should be applied. +# +# Append-only file names are created by Redis following a specific pattern. +# The file name's prefix is based on the 'appendfilename' configuration +# parameter, followed by additional information about the sequence and type. +# +# For example, if appendfilename is set to appendonly.aof, the following file +# names could be derived: +# +# - appendonly.aof.1.base.rdb as a base file. +# - appendonly.aof.1.incr.aof, appendonly.aof.2.incr.aof as incremental files. +# - appendonly.aof.manifest as a manifest file. + +appendfilename "appendonly.aof" + +# For convenience, Redis stores all persistent append-only files in a dedicated +# directory. The name of the directory is determined by the appenddirname +# configuration parameter. + +appenddirname "appendonlydir" + +# The fsync() call tells the Operating System to actually write data on disk +# instead of waiting for more data in the output buffer. Some OS will really flush +# data on disk, some other OS will just try to do it ASAP. +# +# Redis supports three different modes: +# +# no: don't fsync, just let the OS flush the data when it wants. Faster. +# always: fsync after every write to the append only log. Slow, Safest. +# everysec: fsync only one time every second. Compromise. +# +# The default is "everysec", as that's usually the right compromise between +# speed and data safety. It's up to you to understand if you can relax this to +# "no" that will let the operating system flush the output buffer when +# it wants, for better performances (but if you can live with the idea of +# some data loss consider the default persistence mode that's snapshotting), +# or on the contrary, use "always" that's very slow but a bit safer than +# everysec. +# +# More details please check the following article: +# http://antirez.com/post/redis-persistence-demystified.html +# +# If unsure, use "everysec". + +# appendfsync always +appendfsync everysec +# appendfsync no + +# When the AOF fsync policy is set to always or everysec, and a background +# saving process (a background save or AOF log background rewriting) is +# performing a lot of I/O against the disk, in some Linux configurations +# Redis may block too long on the fsync() call. Note that there is no fix for +# this currently, as even performing fsync in a different thread will block +# our synchronous write(2) call. +# +# In order to mitigate this problem it's possible to use the following option +# that will prevent fsync() from being called in the main process while a +# BGSAVE or BGREWRITEAOF is in progress. +# +# This means that while another child is saving, the durability of Redis is +# the same as "appendfsync no". In practical terms, this means that it is +# possible to lose up to 30 seconds of log in the worst scenario (with the +# default Linux settings). +# +# If you have latency problems turn this to "yes". Otherwise leave it as +# "no" that is the safest pick from the point of view of durability. + +no-appendfsync-on-rewrite no + +# Automatic rewrite of the append only file. +# Redis is able to automatically rewrite the log file implicitly calling +# BGREWRITEAOF when the AOF log size grows by the specified percentage. +# +# This is how it works: Redis remembers the size of the AOF file after the +# latest rewrite (if no rewrite has happened since the restart, the size of +# the AOF at startup is used). +# +# This base size is compared to the current size. If the current size is +# bigger than the specified percentage, the rewrite is triggered. Also +# you need to specify a minimal size for the AOF file to be rewritten, this +# is useful to avoid rewriting the AOF file even if the percentage increase +# is reached but it is still pretty small. +# +# Specify a percentage of zero in order to disable the automatic AOF +# rewrite feature. + +auto-aof-rewrite-percentage 100 +auto-aof-rewrite-min-size 64mb + +# An AOF file may be found to be truncated at the end during the Redis +# startup process, when the AOF data gets loaded back into memory. +# This may happen when the system where Redis is running +# crashes, especially when an ext4 filesystem is mounted without the +# data=ordered option (however this can't happen when Redis itself +# crashes or aborts but the operating system still works correctly). +# +# Redis can either exit with an error when this happens, or load as much +# data as possible (the default now) and start if the AOF file is found +# to be truncated at the end. The following option controls this behavior. +# +# If aof-load-truncated is set to yes, a truncated AOF file is loaded and +# the Redis server starts emitting a log to inform the user of the event. +# Otherwise if the option is set to no, the server aborts with an error +# and refuses to start. When the option is set to no, the user requires +# to fix the AOF file using the "redis-check-aof" utility before to restart +# the server. +# +# Note that if the AOF file will be found to be corrupted in the middle +# the server will still exit with an error. This option only applies when +# Redis will try to read more data from the AOF file but not enough bytes +# will be found. +aof-load-truncated yes + +# Redis can create append-only base files in either RDB or AOF formats. Using +# the RDB format is always faster and more efficient, and disabling it is only +# supported for backward compatibility purposes. +aof-use-rdb-preamble yes + +# Redis supports recording timestamp annotations in the AOF to support restoring +# the data from a specific point-in-time. However, using this capability changes +# the AOF format in a way that may not be compatible with existing AOF parsers. +aof-timestamp-enabled no + +################################ SHUTDOWN ##################################### + +# Maximum time to wait for replicas when shutting down, in seconds. +# +# During shut down, a grace period allows any lagging replicas to catch up with +# the latest replication offset before the master exists. This period can +# prevent data loss, especially for deployments without configured disk backups. +# +# The 'shutdown-timeout' value is the grace period's duration in seconds. It is +# only applicable when the instance has replicas. To disable the feature, set +# the value to 0. +# +# shutdown-timeout 10 + +# When Redis receives a SIGINT or SIGTERM, shutdown is initiated and by default +# an RDB snapshot is written to disk in a blocking operation if save points are configured. +# The options used on signaled shutdown can include the following values: +# default: Saves RDB snapshot only if save points are configured. +# Waits for lagging replicas to catch up. +# save: Forces a DB saving operation even if no save points are configured. +# nosave: Prevents DB saving operation even if one or more save points are configured. +# now: Skips waiting for lagging replicas. +# force: Ignores any errors that would normally prevent the server from exiting. +# +# Any combination of values is allowed as long as "save" and "nosave" are not set simultaneously. +# Example: "nosave force now" +# +# shutdown-on-sigint default +# shutdown-on-sigterm default + +################ NON-DETERMINISTIC LONG BLOCKING COMMANDS ##################### + +# Maximum time in milliseconds for EVAL scripts, functions and in some cases +# modules' commands before Redis can start processing or rejecting other clients. +# +# If the maximum execution time is reached Redis will start to reply to most +# commands with a BUSY error. +# +# In this state Redis will only allow a handful of commands to be executed. +# For instance, SCRIPT KILL, FUNCTION KILL, SHUTDOWN NOSAVE and possibly some +# module specific 'allow-busy' commands. +# +# SCRIPT KILL and FUNCTION KILL will only be able to stop a script that did not +# yet call any write commands, so SHUTDOWN NOSAVE may be the only way to stop +# the server in the case a write command was already issued by the script when +# the user doesn't want to wait for the natural termination of the script. +# +# The default is 5 seconds. It is possible to set it to 0 or a negative value +# to disable this mechanism (uninterrupted execution). Note that in the past +# this config had a different name, which is now an alias, so both of these do +# the same: +# lua-time-limit 5000 +# busy-reply-threshold 5000 + +################################ REDIS CLUSTER ############################### + +# Normal Redis instances can't be part of a Redis Cluster; only nodes that are +# started as cluster nodes can. In order to start a Redis instance as a +# cluster node enable the cluster support uncommenting the following: +# +# cluster-enabled yes + +# Every cluster node has a cluster configuration file. This file is not +# intended to be edited by hand. It is created and updated by Redis nodes. +# Every Redis Cluster node requires a different cluster configuration file. +# Make sure that instances running in the same system do not have +# overlapping cluster configuration file names. +# +# cluster-config-file nodes-6379.conf + +# Cluster node timeout is the amount of milliseconds a node must be unreachable +# for it to be considered in failure state. +# Most other internal time limits are a multiple of the node timeout. +# +# cluster-node-timeout 15000 + +# The cluster port is the port that the cluster bus will listen for inbound connections on. When set +# to the default value, 0, it will be bound to the command port + 10000. Setting this value requires +# you to specify the cluster bus port when executing cluster meet. +# cluster-port 0 + +# A replica of a failing master will avoid to start a failover if its data +# looks too old. +# +# There is no simple way for a replica to actually have an exact measure of +# its "data age", so the following two checks are performed: +# +# 1) If there are multiple replicas able to failover, they exchange messages +# in order to try to give an advantage to the replica with the best +# replication offset (more data from the master processed). +# Replicas will try to get their rank by offset, and apply to the start +# of the failover a delay proportional to their rank. +# +# 2) Every single replica computes the time of the last interaction with +# its master. This can be the last ping or command received (if the master +# is still in the "connected" state), or the time that elapsed since the +# disconnection with the master (if the replication link is currently down). +# If the last interaction is too old, the replica will not try to failover +# at all. +# +# The point "2" can be tuned by user. Specifically a replica will not perform +# the failover if, since the last interaction with the master, the time +# elapsed is greater than: +# +# (node-timeout * cluster-replica-validity-factor) + repl-ping-replica-period +# +# So for example if node-timeout is 30 seconds, and the cluster-replica-validity-factor +# is 10, and assuming a default repl-ping-replica-period of 10 seconds, the +# replica will not try to failover if it was not able to talk with the master +# for longer than 310 seconds. +# +# A large cluster-replica-validity-factor may allow replicas with too old data to failover +# a master, while a too small value may prevent the cluster from being able to +# elect a replica at all. +# +# For maximum availability, it is possible to set the cluster-replica-validity-factor +# to a value of 0, which means, that replicas will always try to failover the +# master regardless of the last time they interacted with the master. +# (However they'll always try to apply a delay proportional to their +# offset rank). +# +# Zero is the only value able to guarantee that when all the partitions heal +# the cluster will always be able to continue. +# +# cluster-replica-validity-factor 10 + +# Cluster replicas are able to migrate to orphaned masters, that are masters +# that are left without working replicas. This improves the cluster ability +# to resist to failures as otherwise an orphaned master can't be failed over +# in case of failure if it has no working replicas. +# +# Replicas migrate to orphaned masters only if there are still at least a +# given number of other working replicas for their old master. This number +# is the "migration barrier". A migration barrier of 1 means that a replica +# will migrate only if there is at least 1 other working replica for its master +# and so forth. It usually reflects the number of replicas you want for every +# master in your cluster. +# +# Default is 1 (replicas migrate only if their masters remain with at least +# one replica). To disable migration just set it to a very large value or +# set cluster-allow-replica-migration to 'no'. +# A value of 0 can be set but is useful only for debugging and dangerous +# in production. +# +# cluster-migration-barrier 1 + +# Turning off this option allows to use less automatic cluster configuration. +# It both disables migration to orphaned masters and migration from masters +# that became empty. +# +# Default is 'yes' (allow automatic migrations). +# +# cluster-allow-replica-migration yes + +# By default Redis Cluster nodes stop accepting queries if they detect there +# is at least a hash slot uncovered (no available node is serving it). +# This way if the cluster is partially down (for example a range of hash slots +# are no longer covered) all the cluster becomes, eventually, unavailable. +# It automatically returns available as soon as all the slots are covered again. +# +# However sometimes you want the subset of the cluster which is working, +# to continue to accept queries for the part of the key space that is still +# covered. In order to do so, just set the cluster-require-full-coverage +# option to no. +# +# cluster-require-full-coverage yes + +# This option, when set to yes, prevents replicas from trying to failover its +# master during master failures. However the replica can still perform a +# manual failover, if forced to do so. +# +# This is useful in different scenarios, especially in the case of multiple +# data center operations, where we want one side to never be promoted if not +# in the case of a total DC failure. +# +# cluster-replica-no-failover no + +# This option, when set to yes, allows nodes to serve read traffic while the +# cluster is in a down state, as long as it believes it owns the slots. +# +# This is useful for two cases. The first case is for when an application +# doesn't require consistency of data during node failures or network partitions. +# One example of this is a cache, where as long as the node has the data it +# should be able to serve it. +# +# The second use case is for configurations that don't meet the recommended +# three shards but want to enable cluster mode and scale later. A +# master outage in a 1 or 2 shard configuration causes a read/write outage to the +# entire cluster without this option set, with it set there is only a write outage. +# Without a quorum of masters, slot ownership will not change automatically. +# +# cluster-allow-reads-when-down no + +# This option, when set to yes, allows nodes to serve pubsub shard traffic while +# the cluster is in a down state, as long as it believes it owns the slots. +# +# This is useful if the application would like to use the pubsub feature even when +# the cluster global stable state is not OK. If the application wants to make sure only +# one shard is serving a given channel, this feature should be kept as yes. +# +# cluster-allow-pubsubshard-when-down yes + +# Cluster link send buffer limit is the limit on the memory usage of an individual +# cluster bus link's send buffer in bytes. Cluster links would be freed if they exceed +# this limit. This is to primarily prevent send buffers from growing unbounded on links +# toward slow peers (E.g. PubSub messages being piled up). +# This limit is disabled by default. Enable this limit when 'mem_cluster_links' INFO field +# and/or 'send-buffer-allocated' entries in the 'CLUSTER LINKS` command output continuously increase. +# Minimum limit of 1gb is recommended so that cluster link buffer can fit in at least a single +# PubSub message by default. (client-query-buffer-limit default value is 1gb) +# +# cluster-link-sendbuf-limit 0 + +# Clusters can configure their announced hostname using this config. This is a common use case for +# applications that need to use TLS Server Name Indication (SNI) or dealing with DNS based +# routing. By default this value is only shown as additional metadata in the CLUSTER SLOTS +# command, but can be changed using 'cluster-preferred-endpoint-type' config. This value is +# communicated along the clusterbus to all nodes, setting it to an empty string will remove +# the hostname and also propagate the removal. +# +# cluster-announce-hostname "" + +# Clusters can advertise how clients should connect to them using either their IP address, +# a user defined hostname, or by declaring they have no endpoint. Which endpoint is +# shown as the preferred endpoint is set by using the cluster-preferred-endpoint-type +# config with values 'ip', 'hostname', or 'unknown-endpoint'. This value controls how +# the endpoint returned for MOVED/ASKING requests as well as the first field of CLUSTER SLOTS. +# If the preferred endpoint type is set to hostname, but no announced hostname is set, a '?' +# will be returned instead. +# +# When a cluster advertises itself as having an unknown endpoint, it's indicating that +# the server doesn't know how clients can reach the cluster. This can happen in certain +# networking situations where there are multiple possible routes to the node, and the +# server doesn't know which one the client took. In this case, the server is expecting +# the client to reach out on the same endpoint it used for making the last request, but use +# the port provided in the response. +# +# cluster-preferred-endpoint-type ip + +# In order to setup your cluster make sure to read the documentation +# available at https://redis.io web site. + +########################## CLUSTER DOCKER/NAT support ######################## + +# In certain deployments, Redis Cluster nodes address discovery fails, because +# addresses are NAT-ted or because ports are forwarded (the typical case is +# Docker and other containers). +# +# In order to make Redis Cluster working in such environments, a static +# configuration where each node knows its public address is needed. The +# following four options are used for this scope, and are: +# +# * cluster-announce-ip +# * cluster-announce-port +# * cluster-announce-tls-port +# * cluster-announce-bus-port +# +# Each instructs the node about its address, client ports (for connections +# without and with TLS) and cluster message bus port. The information is then +# published in the header of the bus packets so that other nodes will be able to +# correctly map the address of the node publishing the information. +# +# If cluster-tls is set to yes and cluster-announce-tls-port is omitted or set +# to zero, then cluster-announce-port refers to the TLS port. Note also that +# cluster-announce-tls-port has no effect if cluster-tls is set to no. +# +# If the above options are not used, the normal Redis Cluster auto-detection +# will be used instead. +# +# Note that when remapped, the bus port may not be at the fixed offset of +# clients port + 10000, so you can specify any port and bus-port depending +# on how they get remapped. If the bus-port is not set, a fixed offset of +# 10000 will be used as usual. +# +# Example: +# +# cluster-announce-ip 10.1.1.5 +# cluster-announce-tls-port 6379 +# cluster-announce-port 0 +# cluster-announce-bus-port 6380 + +################################## SLOW LOG ################################### + +# The Redis Slow Log is a system to log queries that exceeded a specified +# execution time. The execution time does not include the I/O operations +# like talking with the client, sending the reply and so forth, +# but just the time needed to actually execute the command (this is the only +# stage of command execution where the thread is blocked and can not serve +# other requests in the meantime). +# +# You can configure the slow log with two parameters: one tells Redis +# what is the execution time, in microseconds, to exceed in order for the +# command to get logged, and the other parameter is the length of the +# slow log. When a new command is logged the oldest one is removed from the +# queue of logged commands. + +# The following time is expressed in microseconds, so 1000000 is equivalent +# to one second. Note that a negative number disables the slow log, while +# a value of zero forces the logging of every command. +slowlog-log-slower-than 10000 + +# There is no limit to this length. Just be aware that it will consume memory. +# You can reclaim memory used by the slow log with SLOWLOG RESET. +slowlog-max-len 128 + +################################ LATENCY MONITOR ############################## + +# The Redis latency monitoring subsystem samples different operations +# at runtime in order to collect data related to possible sources of +# latency of a Redis instance. +# +# Via the LATENCY command this information is available to the user that can +# print graphs and obtain reports. +# +# The system only logs operations that were performed in a time equal or +# greater than the amount of milliseconds specified via the +# latency-monitor-threshold configuration directive. When its value is set +# to zero, the latency monitor is turned off. +# +# By default latency monitoring is disabled since it is mostly not needed +# if you don't have latency issues, and collecting data has a performance +# impact, that while very small, can be measured under big load. Latency +# monitoring can easily be enabled at runtime using the command +# "CONFIG SET latency-monitor-threshold " if needed. +latency-monitor-threshold 0 + +################################ LATENCY TRACKING ############################## + +# The Redis extended latency monitoring tracks the per command latencies and enables +# exporting the percentile distribution via the INFO latencystats command, +# and cumulative latency distributions (histograms) via the LATENCY command. +# +# By default, the extended latency monitoring is enabled since the overhead +# of keeping track of the command latency is very small. +# latency-tracking yes + +# By default the exported latency percentiles via the INFO latencystats command +# are the p50, p99, and p999. +# latency-tracking-info-percentiles 50 99 99.9 + +############################# EVENT NOTIFICATION ############################## + +# Redis can notify Pub/Sub clients about events happening in the key space. +# This feature is documented at https://redis.io/topics/notifications +# +# For instance if keyspace events notification is enabled, and a client +# performs a DEL operation on key "foo" stored in the Database 0, two +# messages will be published via Pub/Sub: +# +# PUBLISH __keyspace@0__:foo del +# PUBLISH __keyevent@0__:del foo +# +# It is possible to select the events that Redis will notify among a set +# of classes. Every class is identified by a single character: +# +# K Keyspace events, published with __keyspace@__ prefix. +# E Keyevent events, published with __keyevent@__ prefix. +# g Generic commands (non-type specific) like DEL, EXPIRE, RENAME, ... +# $ String commands +# l List commands +# s Set commands +# h Hash commands +# z Sorted set commands +# x Expired events (events generated every time a key expires) +# e Evicted events (events generated when a key is evicted for maxmemory) +# n New key events (Note: not included in the 'A' class) +# t Stream commands +# d Module key type events +# m Key-miss events (Note: It is not included in the 'A' class) +# A Alias for g$lshzxetd, so that the "AKE" string means all the events +# (Except key-miss events which are excluded from 'A' due to their +# unique nature). +# +# The "notify-keyspace-events" takes as argument a string that is composed +# of zero or multiple characters. The empty string means that notifications +# are disabled. +# +# Example: to enable list and generic events, from the point of view of the +# event name, use: +# +# notify-keyspace-events Elg +# +# Example 2: to get the stream of the expired keys subscribing to channel +# name __keyevent@0__:expired use: +# +# notify-keyspace-events Ex +# +# By default all notifications are disabled because most users don't need +# this feature and the feature has some overhead. Note that if you don't +# specify at least one of K or E, no events will be delivered. +notify-keyspace-events "" + +############################### ADVANCED CONFIG ############################### + +# Hashes are encoded using a memory efficient data structure when they have a +# small number of entries, and the biggest entry does not exceed a given +# threshold. These thresholds can be configured using the following directives. +hash-max-listpack-entries 512 +hash-max-listpack-value 64 + +# Lists are also encoded in a special way to save a lot of space. +# The number of entries allowed per internal list node can be specified +# as a fixed maximum size or a maximum number of elements. +# For a fixed maximum size, use -5 through -1, meaning: +# -5: max size: 64 Kb <-- not recommended for normal workloads +# -4: max size: 32 Kb <-- not recommended +# -3: max size: 16 Kb <-- probably not recommended +# -2: max size: 8 Kb <-- good +# -1: max size: 4 Kb <-- good +# Positive numbers mean store up to _exactly_ that number of elements +# per list node. +# The highest performing option is usually -2 (8 Kb size) or -1 (4 Kb size), +# but if your use case is unique, adjust the settings as necessary. +list-max-listpack-size -2 + +# Lists may also be compressed. +# Compress depth is the number of quicklist ziplist nodes from *each* side of +# the list to *exclude* from compression. The head and tail of the list +# are always uncompressed for fast push/pop operations. Settings are: +# 0: disable all list compression +# 1: depth 1 means "don't start compressing until after 1 node into the list, +# going from either the head or tail" +# So: [head]->node->node->...->node->[tail] +# [head], [tail] will always be uncompressed; inner nodes will compress. +# 2: [head]->[next]->node->node->...->node->[prev]->[tail] +# 2 here means: don't compress head or head->next or tail->prev or tail, +# but compress all nodes between them. +# 3: [head]->[next]->[next]->node->node->...->node->[prev]->[prev]->[tail] +# etc. +list-compress-depth 0 + +# Sets have a special encoding in just one case: when a set is composed +# of just strings that happen to be integers in radix 10 in the range +# of 64 bit signed integers. +# The following configuration setting sets the limit in the size of the +# set in order to use this special memory saving encoding. +set-max-intset-entries 512 + +# Similarly to hashes and lists, sorted sets are also specially encoded in +# order to save a lot of space. This encoding is only used when the length and +# elements of a sorted set are below the following limits: +zset-max-listpack-entries 128 +zset-max-listpack-value 64 + +# HyperLogLog sparse representation bytes limit. The limit includes the +# 16 bytes header. When an HyperLogLog using the sparse representation crosses +# this limit, it is converted into the dense representation. +# +# A value greater than 16000 is totally useless, since at that point the +# dense representation is more memory efficient. +# +# The suggested value is ~ 3000 in order to have the benefits of +# the space efficient encoding without slowing down too much PFADD, +# which is O(N) with the sparse encoding. The value can be raised to +# ~ 10000 when CPU is not a concern, but space is, and the data set is +# composed of many HyperLogLogs with cardinality in the 0 - 15000 range. +hll-sparse-max-bytes 3000 + +# Streams macro node max size / items. The stream data structure is a radix +# tree of big nodes that encode multiple items inside. Using this configuration +# it is possible to configure how big a single node can be in bytes, and the +# maximum number of items it may contain before switching to a new node when +# appending new stream entries. If any of the following settings are set to +# zero, the limit is ignored, so for instance it is possible to set just a +# max entries limit by setting max-bytes to 0 and max-entries to the desired +# value. +stream-node-max-bytes 4096 +stream-node-max-entries 100 + +# Active rehashing uses 1 millisecond every 100 milliseconds of CPU time in +# order to help rehashing the main Redis hash table (the one mapping top-level +# keys to values). The hash table implementation Redis uses (see dict.c) +# performs a lazy rehashing: the more operation you run into a hash table +# that is rehashing, the more rehashing "steps" are performed, so if the +# server is idle the rehashing is never complete and some more memory is used +# by the hash table. +# +# The default is to use this millisecond 10 times every second in order to +# actively rehash the main dictionaries, freeing memory when possible. +# +# If unsure: +# use "activerehashing no" if you have hard latency requirements and it is +# not a good thing in your environment that Redis can reply from time to time +# to queries with 2 milliseconds delay. +# +# use "activerehashing yes" if you don't have such hard requirements but +# want to free memory asap when possible. +activerehashing yes + +# The client output buffer limits can be used to force disconnection of clients +# that are not reading data from the server fast enough for some reason (a +# common reason is that a Pub/Sub client can't consume messages as fast as the +# publisher can produce them). +# +# The limit can be set differently for the three different classes of clients: +# +# normal -> normal clients including MONITOR clients +# replica -> replica clients +# pubsub -> clients subscribed to at least one pubsub channel or pattern +# +# The syntax of every client-output-buffer-limit directive is the following: +# +# client-output-buffer-limit +# +# A client is immediately disconnected once the hard limit is reached, or if +# the soft limit is reached and remains reached for the specified number of +# seconds (continuously). +# So for instance if the hard limit is 32 megabytes and the soft limit is +# 16 megabytes / 10 seconds, the client will get disconnected immediately +# if the size of the output buffers reach 32 megabytes, but will also get +# disconnected if the client reaches 16 megabytes and continuously overcomes +# the limit for 10 seconds. +# +# By default normal clients are not limited because they don't receive data +# without asking (in a push way), but just after a request, so only +# asynchronous clients may create a scenario where data is requested faster +# than it can read. +# +# Instead there is a default limit for pubsub and replica clients, since +# subscribers and replicas receive data in a push fashion. +# +# Note that it doesn't make sense to set the replica clients output buffer +# limit lower than the repl-backlog-size config (partial sync will succeed +# and then replica will get disconnected). +# Such a configuration is ignored (the size of repl-backlog-size will be used). +# This doesn't have memory consumption implications since the replica client +# will share the backlog buffers memory. +# +# Both the hard or the soft limit can be disabled by setting them to zero. +client-output-buffer-limit normal 0 0 0 +client-output-buffer-limit replica 256mb 64mb 60 +client-output-buffer-limit pubsub 32mb 8mb 60 + +# Client query buffers accumulate new commands. They are limited to a fixed +# amount by default in order to avoid that a protocol desynchronization (for +# instance due to a bug in the client) will lead to unbound memory usage in +# the query buffer. However you can configure it here if you have very special +# needs, such us huge multi/exec requests or alike. +# +# client-query-buffer-limit 1gb + +# In some scenarios client connections can hog up memory leading to OOM +# errors or data eviction. To avoid this we can cap the accumulated memory +# used by all client connections (all pubsub and normal clients). Once we +# reach that limit connections will be dropped by the server freeing up +# memory. The server will attempt to drop the connections using the most +# memory first. We call this mechanism "client eviction". +# +# Client eviction is configured using the maxmemory-clients setting as follows: +# 0 - client eviction is disabled (default) +# +# A memory value can be used for the client eviction threshold, +# for example: +# maxmemory-clients 1g +# +# A percentage value (between 1% and 100%) means the client eviction threshold +# is based on a percentage of the maxmemory setting. For example to set client +# eviction at 5% of maxmemory: +# maxmemory-clients 5% + +# In the Redis protocol, bulk requests, that are, elements representing single +# strings, are normally limited to 512 mb. However you can change this limit +# here, but must be 1mb or greater +# +# proto-max-bulk-len 512mb + +# Redis calls an internal function to perform many background tasks, like +# closing connections of clients in timeout, purging expired keys that are +# never requested, and so forth. +# +# Not all tasks are performed with the same frequency, but Redis checks for +# tasks to perform according to the specified "hz" value. +# +# By default "hz" is set to 10. Raising the value will use more CPU when +# Redis is idle, but at the same time will make Redis more responsive when +# there are many keys expiring at the same time, and timeouts may be +# handled with more precision. +# +# The range is between 1 and 500, however a value over 100 is usually not +# a good idea. Most users should use the default of 10 and raise this up to +# 100 only in environments where very low latency is required. +hz 10 + +# Normally it is useful to have an HZ value which is proportional to the +# number of clients connected. This is useful in order, for instance, to +# avoid too many clients are processed for each background task invocation +# in order to avoid latency spikes. +# +# Since the default HZ value by default is conservatively set to 10, Redis +# offers, and enables by default, the ability to use an adaptive HZ value +# which will temporarily raise when there are many connected clients. +# +# When dynamic HZ is enabled, the actual configured HZ will be used +# as a baseline, but multiples of the configured HZ value will be actually +# used as needed once more clients are connected. In this way an idle +# instance will use very little CPU time while a busy instance will be +# more responsive. +dynamic-hz yes + +# When a child rewrites the AOF file, if the following option is enabled +# the file will be fsync-ed every 4 MB of data generated. This is useful +# in order to commit the file to the disk more incrementally and avoid +# big latency spikes. +aof-rewrite-incremental-fsync yes + +# When redis saves RDB file, if the following option is enabled +# the file will be fsync-ed every 4 MB of data generated. This is useful +# in order to commit the file to the disk more incrementally and avoid +# big latency spikes. +rdb-save-incremental-fsync yes + +# Redis LFU eviction (see maxmemory setting) can be tuned. However it is a good +# idea to start with the default settings and only change them after investigating +# how to improve the performances and how the keys LFU change over time, which +# is possible to inspect via the OBJECT FREQ command. +# +# There are two tunable parameters in the Redis LFU implementation: the +# counter logarithm factor and the counter decay time. It is important to +# understand what the two parameters mean before changing them. +# +# The LFU counter is just 8 bits per key, it's maximum value is 255, so Redis +# uses a probabilistic increment with logarithmic behavior. Given the value +# of the old counter, when a key is accessed, the counter is incremented in +# this way: +# +# 1. A random number R between 0 and 1 is extracted. +# 2. A probability P is calculated as 1/(old_value*lfu_log_factor+1). +# 3. The counter is incremented only if R < P. +# +# The default lfu-log-factor is 10. This is a table of how the frequency +# counter changes with a different number of accesses with different +# logarithmic factors: +# +# +--------+------------+------------+------------+------------+------------+ +# | factor | 100 hits | 1000 hits | 100K hits | 1M hits | 10M hits | +# +--------+------------+------------+------------+------------+------------+ +# | 0 | 104 | 255 | 255 | 255 | 255 | +# +--------+------------+------------+------------+------------+------------+ +# | 1 | 18 | 49 | 255 | 255 | 255 | +# +--------+------------+------------+------------+------------+------------+ +# | 10 | 10 | 18 | 142 | 255 | 255 | +# +--------+------------+------------+------------+------------+------------+ +# | 100 | 8 | 11 | 49 | 143 | 255 | +# +--------+------------+------------+------------+------------+------------+ +# +# NOTE: The above table was obtained by running the following commands: +# +# redis-benchmark -n 1000000 incr foo +# redis-cli object freq foo +# +# NOTE 2: The counter initial value is 5 in order to give new objects a chance +# to accumulate hits. +# +# The counter decay time is the time, in minutes, that must elapse in order +# for the key counter to be divided by two (or decremented if it has a value +# less <= 10). +# +# The default value for the lfu-decay-time is 1. A special value of 0 means to +# decay the counter every time it happens to be scanned. +# +# lfu-log-factor 10 +# lfu-decay-time 1 + +########################### ACTIVE DEFRAGMENTATION ####################### +# +# What is active defragmentation? +# ------------------------------- +# +# Active (online) defragmentation allows a Redis server to compact the +# spaces left between small allocations and deallocations of data in memory, +# thus allowing to reclaim back memory. +# +# Fragmentation is a natural process that happens with every allocator (but +# less so with Jemalloc, fortunately) and certain workloads. Normally a server +# restart is needed in order to lower the fragmentation, or at least to flush +# away all the data and create it again. However thanks to this feature +# implemented by Oran Agra for Redis 4.0 this process can happen at runtime +# in a "hot" way, while the server is running. +# +# Basically when the fragmentation is over a certain level (see the +# configuration options below) Redis will start to create new copies of the +# values in contiguous memory regions by exploiting certain specific Jemalloc +# features (in order to understand if an allocation is causing fragmentation +# and to allocate it in a better place), and at the same time, will release the +# old copies of the data. This process, repeated incrementally for all the keys +# will cause the fragmentation to drop back to normal values. +# +# Important things to understand: +# +# 1. This feature is disabled by default, and only works if you compiled Redis +# to use the copy of Jemalloc we ship with the source code of Redis. +# This is the default with Linux builds. +# +# 2. You never need to enable this feature if you don't have fragmentation +# issues. +# +# 3. Once you experience fragmentation, you can enable this feature when +# needed with the command "CONFIG SET activedefrag yes". +# +# The configuration parameters are able to fine tune the behavior of the +# defragmentation process. If you are not sure about what they mean it is +# a good idea to leave the defaults untouched. + +# Active defragmentation is disabled by default +# activedefrag no + +# Minimum amount of fragmentation waste to start active defrag +# active-defrag-ignore-bytes 100mb + +# Minimum percentage of fragmentation to start active defrag +# active-defrag-threshold-lower 10 + +# Maximum percentage of fragmentation at which we use maximum effort +# active-defrag-threshold-upper 100 + +# Minimal effort for defrag in CPU percentage, to be used when the lower +# threshold is reached +# active-defrag-cycle-min 1 + +# Maximal effort for defrag in CPU percentage, to be used when the upper +# threshold is reached +# active-defrag-cycle-max 25 + +# Maximum number of set/hash/zset/list fields that will be processed from +# the main dictionary scan +# active-defrag-max-scan-fields 1000 + +# Jemalloc background thread for purging will be enabled by default +jemalloc-bg-thread yes + +# It is possible to pin different threads and processes of Redis to specific +# CPUs in your system, in order to maximize the performances of the server. +# This is useful both in order to pin different Redis threads in different +# CPUs, but also in order to make sure that multiple Redis instances running +# in the same host will be pinned to different CPUs. +# +# Normally you can do this using the "taskset" command, however it is also +# possible to this via Redis configuration directly, both in Linux and FreeBSD. +# +# You can pin the server/IO threads, bio threads, aof rewrite child process, and +# the bgsave child process. The syntax to specify the cpu list is the same as +# the taskset command: +# +# Set redis server/io threads to cpu affinity 0,2,4,6: +# server_cpulist 0-7:2 +# +# Set bio threads to cpu affinity 1,3: +# bio_cpulist 1,3 +# +# Set aof rewrite child process to cpu affinity 8,9,10,11: +# aof_rewrite_cpulist 8-11 +# +# Set bgsave child process to cpu affinity 1,10,11 +# bgsave_cpulist 1,10-11 + +# In some cases redis will emit warnings and even refuse to start if it detects +# that the system is in bad state, it is possible to suppress these warnings +# by setting the following config which takes a space delimited list of warnings +# to suppress +# +# ignore-warnings ARM64-COW-BUG \ No newline at end of file diff --git a/compose/web_service/nginx_uvicorn/redis/data/.gitkeep b/compose/web_service/nginx_uvicorn/redis/data/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/compose/web_service/nginx_uvicorn/ssl/certs/.gitkeep b/compose/web_service/nginx_uvicorn/ssl/certs/.gitkeep new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/compose/web_service/nginx_uvicorn/ssl/certs/.gitkeep @@ -0,0 +1 @@ + diff --git a/compose/web_service/nginx_uvicorn/ssl/letsencrypt/.gitkeep b/compose/web_service/nginx_uvicorn/ssl/letsencrypt/.gitkeep new file mode 100644 index 0000000..8b13789 --- /dev/null +++ b/compose/web_service/nginx_uvicorn/ssl/letsencrypt/.gitkeep @@ -0,0 +1 @@ + diff --git a/config/app-server/uvicorn/gunicorn_uvicorn.conf.py b/config/app-server/uvicorn/gunicorn_uvicorn.conf.py new file mode 100644 index 0000000..582ad2e --- /dev/null +++ b/config/app-server/uvicorn/gunicorn_uvicorn.conf.py @@ -0,0 +1,253 @@ +""" +Gunicorn Configuration for Production FastAPI Service +===================================================== +환경: Production Level +서버 사양: 쿼드코어 CPU, 4GB RAM, ~50 req/s +백엔드: FastAPI REST API with Uvicorn Workers +프록시: Nginx (SSL/TLS, DDoS, Rate Limiting 처리) +===================================================== +""" + +# ============================================================================ +# 네트워크 바인딩 설정 +# ============================================================================ +# 바인딩 주소 및 포트 +# 역할: Gunicorn이 수신할 네트워크 주소 +# 0.0.0.0:8000 - 모든 네트워크 인터페이스에서 수신 (Docker/컨테이너 환경) +# 127.0.0.1:8000 - 로컬 전용 (Nginx와 동일 호스트, 보안 강화) +# Nginx 연동: Nginx가 외부 트래픽 처리, Gunicorn은 내부 전용 +bind = "0.0.0.0:8000" + +# ============================================================================ +# Worker 프로세스 설정 +# ============================================================================ +# Worker 수 +# 역할: 동시 요청 처리를 위한 프로세스 수 +# 공식: I/O 집약적 작업 = (CPU 코어 * 2) + 1 +# 계산: 쿼드코어(4) → 9개 권장, 하지만 4GB RAM 제약으로 4개 설정 +# 각 워커 메모리: 200-500MB +# 4 워커 × 500MB = 2GB (시스템 예비 2GB 확보) +# 성능: ~50 req/s는 4개 워커로 충분 (워커당 ~12.5 req/s) +# 환경 변수: GUNICORN_WORKERS=6 으로 오버라이드 가능 +# workers = multiprocessing.cpu_count() * 2 + 1 +workers = 4 + +# Worker 클래스 +# 역할: ASGI 애플리케이션(FastAPI) 처리를 위한 Worker 타입 +# uvicorn.workers.UvicornWorker: 비동기 I/O, uvloop 이벤트 루프 +# 기대 효과: sync 워커 대비 2-5배 높은 동시성, 메모리 효율적 +worker_class = "uvicorn.workers.UvicornWorker" + +# Worker 동시 연결 수 (주석 처리 - UvicornWorker는 이 설정 미사용) +# Nginx가 앞단에서 연결 관리하므로 불필요 +# worker_connections = 1000 + +# ============================================================================ +# 프로세스 관리 설정 +# ============================================================================ +# 데몬 모드 +# 역할: 백그라운드 실행 여부 +# False: systemd/Docker가 프로세스 관리 (현대적 방식) +# True: 수동 관리 시 사용 (pidfile 필수) +daemon = False + +# PID 파일 (주석 처리 - systemd/Docker 사용 시 불필요) +# 역할: Master 프로세스 ID 저장 +# 수동 관리 시 활성화: pidfile = '/var/run/gunicorn/gunicorn.pid' +# pidfile = '/tmp/gunicorn.pid' + +# ============================================================================ +# ASGI 애플리케이션 경로 +# ============================================================================ +# ASGI 애플리케이션 경로 +# 역할: Gunicorn이 실행할 FastAPI 앱 지정 +# 형식: "모듈경로:변수명" +# 예: config.asgi:application (Django 스타일) +# main:app (FastAPI 기본) +wsgi_app = "config.asgi:application" + +# ============================================================================ +# 타임아웃 설정 +# ============================================================================ +# Worker 타임아웃 +# 역할: Worker가 요청 처리 최대 허용 시간 (초) +# 동작: 타임아웃 초과 시 Worker 강제 종료 후 재시작 +# 계산: FastAPI REST API 평균 응답 1-5초 +# 파일 업로드 고려 (100MB / 10Mbps = 80초) +# Nginx 연동: proxy_read_timeout(60s)보다 짧거나 같게 설정 +# 30초: 일반 API 응답 충분, 긴 작업은 백그라운드 처리 권장 +timeout = 30 + +# Keep-Alive 타임아웃 +# 역할: HTTP Keep-Alive 연결 유지 시간 (초) +# 동작: 연결 재사용으로 핸드셰이크 오버헤드 감소 +# Nginx 연동: Nginx keepalive_timeout(30s)보다 짧게 설정 +# Nginx가 먼저 종료하도록 하여 리소스 효율화 +# 2초: Nginx 앞단에서 연결 관리하므로 짧게 설정 +keepalive = 2 + +# Graceful 종료 타임아웃 +# 역할: Worker 재시작/종료 시 진행 중인 요청 완료 대기 시간 (초) +# 동작: SIGTERM 수신 후 새 요청 거부, 기존 요청 처리 +# 타임아웃 초과 시 SIGKILL로 강제 종료 +# 기대 효과: Graceful reload로 무중단 배포 +# kill -HUP 또는 systemctl reload gunicorn +# timeout과 동일하게 설정 +graceful_timeout = 30 + +# ============================================================================ +# 프로세스 리소스 관리 (메모리 누수 방지) +# ============================================================================ +# Worker 최대 요청 수 +# 역할: Worker가 처리할 최대 요청 후 자동 재시작 +# 목적: 메모리 누수 방어, 장기 운영 안정성 +# 동작: max_requests 도달 시 Worker graceful 종료 후 재시작 +# 계산: ~50 req/s 기준 +# 1000으로 설정 시 워커당 20초마다 재시작 (1000/50) +# 메모리 누수 우려 시 유지, 안정적이면 5000-10000 증가 가능 +# 모니터링: htop으로 워커 메모리 사용량 추이 확인 +max_requests = 1000 + +# 최대 요청 수 Jitter +# 역할: max_requests에 랜덤성 추가 +# 목적: 모든 Worker가 동시에 재시작하는 것 방지 +# 동작: 실제 재시작 = max_requests ± random(0, jitter) +# 기대 효과: 재시작 부하 분산, 서비스 연속성 보장 +# 권장: max_requests의 5-10% +max_requests_jitter = 50 + +# ============================================================================ +# 애플리케이션 로딩 설정 +# ============================================================================ +# 애플리케이션 사전 로딩 +# 역할: Worker fork 전 앱 로딩 방식 결정 +# False: 각 Worker가 독립적으로 앱 로딩 +# - 장점: Graceful reload 가능 (무중단 배포) +# - 단점: 메모리 중복 사용 (Worker 수만큼) +# True: Master 프로세스에서 앱 로딩 후 Worker fork +# - 장점: 메모리 20-40% 절감 (Copy-on-Write) +# - 단점: reload 시 전체 재시작 필요 (다운타임) +# 프로덕션 권장: False (무중단 배포 우선) +preload_app = False + +# 코드 변경 감지 자동 재시작 +# 역할: 파일 변경 시 Worker 자동 재시작 +# 성능 영향: CPU 5-10% 오버헤드, 메모리 50-100MB 추가 +# 보안: 예기치 않은 재시작으로 서비스 불안정 +# **프로덕션에서는 반드시 False** +# 개발 환경에서만 True 사용 +# 배포: CI/CD 파이프라인에서 명시적 재시작 +reload = False + +# ============================================================================ +# 로깅 설정 +# ============================================================================ +# 애플리케이션 출력 캡처 +# 역할: FastAPI의 print(), logging을 Gunicorn 로그로 리다이렉트 +# False: 앱 로거가 독립적으로 관리 (권장) +# True: stdout/stderr를 errorlog로 통합 +# FastAPI 권장: False (자체 로거 사용) +capture_output = False + +# 로그 레벨 +# 역할: 출력할 로그의 최소 수준 +# 레벨: critical > error > warning > info > debug +# info: 일반 정보 + 에러 (프로덕션 권장) +# warning: 경고 이상만 (로그 양 감소) +# debug: 모든 세부 정보 (성능 저하, 개발용) +loglevel = "info" + +# 액세스 로그 파일 +# 역할: HTTP 요청 로그 저장 +# 형식: 시간별 로그 파일 생성 (access_2025-01-05_14.log) +# 로테이션: 시간별 자동 분리, logrotate 추가 권장 +# 성능: 버퍼링으로 I/O 최적화 +# Docker/K8s: "-" 사용으로 stdout 출력 권장 +accesslog = "/log/uvicorn/uvicorn_access.log" + +# 에러 로그 파일 +# 역할: Gunicorn 에러, Worker 크래시 로그 +# 포함: Worker 타임아웃, 메모리 에러, 예외 등 +# 모니터링: 장애 탐지를 위한 핵심 로그 +errorlog = "/log/uvicorn/uvicorn_error.log" + +# 액세스 로그 포맷 (선택사항, 필요 시 주석 해제) +# 역할: 요청 로그 형식 커스터마이징 +# 기본 포맷으로도 충분, 상세 정보 필요 시 활성화 +access_log_format = ( + '%(h)s %(l)s %(u)s %(t)s "%(r)s" %(s)s %(b)s "%(f)s" "%(a)s" %(D)s %(p)s' +) + +# 워커 프로세스 이름 설정 (모니터링 시 유용) +proc_name = "fastapi_gunicorn" + +# ========================================== +# 성능 최적화 +# ========================================== +# - 최대 2048개의 연결이 Accept Queue에서 대기 가능 +# - 동시에 많은 연결 요청이 들어와도 2048개까지는 거부되지 않음 +# - 실제 적용값 = min(2048, 시스템 somaxconn) +# 낮은 트래픽 (기본값 충분) +# backlog = 2048 # 기본값 사용 +# workers = 4 +# +# 높은 트래픽 (증가 필요) +# backlog = 4096 +# workers = 8 +# OS 설정도 함께 조정 필요 +# /etc/sysctl.conf +# net.core.somaxconn = 4096 +# +# 증가해야 할 때: +# ss -lnt 명령으로 Send-Q가 계속 가득 찬 경우 +# ss -lnt | grep :8000 +# 순간적인 트래픽 급증이 예상되는 경우 +# connection refused 에러가 자주 발생하는 경우 + +backlog = 2048 + +# 임시 파일 디렉토리 (업로드 처리 시 사용) +# 재부팅 시 자동 삭제 +# Gunicorn 기본값 +# worker_tmp_dir = None # /tmp 디렉토리 사용 (디스크 기반) +# 사용하는 경우 (권장): +# 파일 업로드가 많은 서비스 +# 큰 요청/응답 처리 +# 충분한 RAM이 있는 경우 +# RAM이 부족한 경우 +# worker_tmp_dir = "/tmp" # 디스크 사용 +# 파일 업로드/다운로드가 거의 없는 경우 +# worker_tmp_dir = None # 기본값 사용 +# Docker 사용시 고려 필요 +# shm_size: '2gb' # /dev/shm 크기 증가 +# volumes: +# - /dev/shm:/dev/shm # 호스트 공유 (선택) + +# worker_tmp_dir = "/dev/shm" # RAM 기반 tmpfs 사용으로 I/O 성능 향상 +worker_tmp_dir = None + +""" +배포 전 체크리스트: + +[권장] +1. 로그 로테이션 설정 (logrotate) +2. 헬스체크 엔드포인트 구현 (/health) +3. 성능 테스트 (wrk, locust) + +성능 모니터링: + # 프로세스 확인 + ps aux | grep gunicorn + + # 리소스 사용량 + htop -p $(pgrep -d',' gunicorn) + + # 로그 실시간 확인 + tail -f /log/uvicorn/access_*.log + tail -f /log/uvicorn/error_*.log + +설정 최적화 가이드: + - workers: CPU 사용률 80% 이하 유지 + - timeout: 응답 시간 + 여유분 (평균 * 2) + - max_requests: 메모리 누수 없으면 5000-10000으로 증가 + - keepalive: Nginx keepalive_timeout보다 짧게 +""" diff --git a/config/web-server/nginx/gunicorn/conf.d/LICENSE b/config/web-server/nginx/gunicorn/conf.d/LICENSE new file mode 100644 index 0000000..e7b2769 --- /dev/null +++ b/config/web-server/nginx/gunicorn/conf.d/LICENSE @@ -0,0 +1,21 @@ +MIT License + +Copyright (c) 2020 devspoons + +Permission is hereby granted, free of charge, to any person obtaining a copy +of this software and associated documentation files (the "Software"), to deal +in the Software without restriction, including without limitation the rights +to use, copy, modify, merge, publish, distribute, sublicense, and/or sell +copies of the Software, and to permit persons to whom the Software is +furnished to do so, subject to the following conditions: + +The above copyright notice and this permission notice shall be included in all +copies or substantial portions of the Software. + +THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR +IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, +FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE +AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER +LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, +OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE +SOFTWARE. diff --git a/config/web-server/nginx/gunicorn/conf.d/bad_bot.conf b/config/web-server/nginx/gunicorn/conf.d/bad_bot.conf new file mode 100644 index 0000000..3622c1a --- /dev/null +++ b/config/web-server/nginx/gunicorn/conf.d/bad_bot.conf @@ -0,0 +1,562 @@ +map $http_user_agent $bad_bot { + default 0; + ~*360Spider 1; + ~*360Spider 1; + ~*80legs 1; + ~*Abonti 1; + ~*Aboundex 1; + ~*AcoonBot 1; + ~*Acunetix 1; + ~*adbeat_bot 1; + ~*AddThis.com 1; + ~*adidxbot 1; + ~*ADmantX 1; + ~*AhrefsBot 1; + ~*AIBOT 1; + ~*aiHitBot 1; + ~*Alexibot 1; + ~*Alligator 1; + ~*AllSubmitter 1; + ~*AngloINFO 1; + ~*Antelope 1; + ~*Apexoo 1; + ~*asterias 1; + ~*attach 1; + ~*BackDoorBot 1; + ~*BackStreet 1; + ~*BackWeb 1; + ~*Badass 1; + ~*Baid 1; + ~*Bandit 1; + ~*BatchFTP 1; + ~*BBBike 1; + ~*BeetleBot 1; + ~*Bigfoot 1; + ~*billigerbot 1; + ~*binlar 1; + ~*bitlybot 1; + ~*Black.Hole 1; + ~*BlackWidow 1; + ~*BLEXBot 1; + ~*Blow 1; + ~*BlowFish 1; + ~*BLP_bbot 1; + ~*BoardReader 1; + ~*Bolt\ 0 1; + ~*BOT\ for\ JCE 1; + ~*Bot\ mailto\:craftbot@yahoo\.com 1; + ~*BotALot 1; + ~*Buddy 1; + ~*BuiltBotTough 1; + ~*Bullseye 1; + ~*BunnySlippers 1; + ~*casper 1; + ~*CazoodleBot 1; + ~*CCBot 1; + ~*Cegbfeieh 1; + ~*checkprivacy 1; + ~*CheeseBot 1; + ~*CherryPicker 1; + ~*ChinaClaw 1; + ~*chromeframe 1; + ~*Clerkbot 1; + ~*Cliqzbot 1; + ~*clshttp 1; + ~*Cogentbot 1; + ~*cognitiveseo 1; + ~*Collector 1; + ~*CommonCrawler 1; + ~*comodo 1; + ~*Copier 1; + ~*CopyRightCheck 1; + ~*cosmos 1; + ~*CPython 1; + ~*crawler4j 1; + ~*Crawlera 1; + ~*CRAZYWEBCRAWLER 1; + ~*Crescent 1; + ~*CSHttp 1; + ~*Curious 1; + ~*Curl 1; + ~*Custo 1; + ~*CWS_proxy 1; + ~*Default\ Browser\ 0 1; + ~*Demon 1; + ~*DeuSu 1; + ~*Devil 1; + ~*diavol 1; + ~*DigExt 1; + ~*Digincore 1; + ~*DIIbot 1; + ~*DISCo 1; + ~*discobot 1; + ~*DittoSpyder 1; + ~*DoCoMo 1; + ~*DotBot 1; + ~*Download.Demon 1; + ~*Download.Devil 1; + ~*Download.Wonder 1; + ~*Download\ Demo 1; + ~*dragonfly 1; + ~*Drip 1; + ~*DTS.Agent 1; + ~*EasouSpider 1; + ~*EasyDL 1; + ~*ebingbong 1; + ~*eCatch 1; + ~*ecxi 1; + ~*EirGrabber 1; + ~*Elmer 1; + ~*EmailCollector 1; + ~*EmailSiphon 1; + ~*EmailWolf 1; + ~*EroCrawler 1; + ~*Exabot 1; + ~*ExaleadCloudView 1; + ~*ExpertSearch 1; + ~*ExpertSearchSpider 1; + ~*Express 1; + ~*Express\ WebPictures 1; + ~*extract 1; + ~*Extractor 1; + ~*ExtractorPro 1; + ~*EyeNetIE 1; + ~*Ezooms 1; + ~*F2S 1; + ~*FastSeek 1; + ~*feedfinder 1; + ~*FeedlyBot 1; + ~*FHscan 1; + ~*finbot 1; + ~*Flamingo_SearchEngine 1; + ~*FlappyBot 1; + ~*FlashGet 1; + ~*flicky 1; + ~*Flipboard 1; + ~*FlipboardProxy 1; + ~*flunky 1; + ~*Foobot 1; + ~*FrontPage 1; + ~*g00g1e 1; + ~*GalaxyBot 1; + ~*genieo 1; + ~*Genieo 1; + ~*GetRight 1; + ~*GetWeb\! 1; + ~*GigablastOpenSource 1; + ~*Go\-Ahead\-Got\-It 1; + ~*Go\!Zilla 1; + ~*gotit 1; + ~*GozaikBot 1; + ~*grab 1; + ~*Grabber 1; + ~*GrabNet 1; + ~*Grafula 1; + ~*GrapeshotCrawler 1; + ~*GT\:\:WWW 1; + ~*GTB5 1; + ~*Guzzle 1; + ~*harvest 1; + ~*Harvest 1; + ~*HEADMasterSEO 1; + ~*heritrix 1; + ~*hloader 1; + ~*HMView 1; + ~*HomePageBot 1; + ~*htmlparser 1; + ~*HTTP\:\:Lite 1; + ~*httrack 1; + ~*HTTrack 1; + ~*HubSpot 1; + ~*humanlinks 1; + ~*ia_archiver 1; + ~*icarus6 1; + ~*id\-search 1; + ~*IDBot 1; + ~*IlseBot 1; + ~*Image.Stripper 1; + ~*Image.Sucker 1; + ~*Image\ Stripper 1; + ~*Image\ Sucker 1; + ~*imagefetch 1; + ~*Indigonet 1; + ~*Indy\ Library 1; + ~*InfoNaviRobot 1; + ~*InfoTekies 1; + ~*integromedb 1; + ~*Intelliseek 1; + ~*InterGET 1; + ~*Internet\ Ninja 1; + ~*InternetSeer\.com 1; + ~*Iria 1; + ~*IRLbot 1; + ~*ISC\ Systems\ iRc\ Search\ 2\.1 1; + ~*jakarta 1; + ~*Jakarta 1; + ~*Java 1; + ~*JennyBot 1; + ~*JetCar 1; + ~*JikeSpider 1; + ~*JobdiggerSpider 1; + ~*JOC 1; + ~*JOC\ Web\ Spider 1; + ~*Jooblebot 1; + ~*JustView 1; + ~*Jyxobot 1; + ~*kanagawa 1; + ~*Kenjin.Spider 1; + ~*Keyword.Density 1; + ~*KINGSpider 1; + ~*kmccrew 1; + ~*larbin 1; + ~*LeechFTP 1; + ~*LeechGet 1; + ~*LexiBot 1; + ~*lftp 1; + ~*libWeb 1; + ~*libwww 1; + ~*libwww-perl 1; + ~*likse 1; + ~*Lingewoud 1; + ~*LinkChecker 1; + ~*linkdexbot 1; + ~*LinkextractorPro 1; + ~*LinkScan 1; + ~*LinksCrawler 1; + ~*LinksManager\.com_bot 1; + ~*linkwalker 1; + ~*LinkWalker 1; + ~*LinqiaRSSBot 1; + ~*LivelapBot 1; + ~*LNSpiderguy 1; + ~*ltx71 1; + ~*LubbersBot 1; + ~*lwp\-trivial 1; + ~*Mag-Net 1; + ~*Magnet 1; + ~*Mail.RU_Bot 1; + ~*majestic12 1; + ~*MarkWatch 1; + ~*Mass.Downloader 1; + ~*Mass\ Downloader 1; + ~*masscan 1; + ~*Mata.Hari 1; + ~*maverick 1; + ~*Maxthon$ 1; + ~*Mediatoolkitbot 1; + ~*megaindex 1; + ~*MegaIndex 1; + ~*Memo 1; + ~*MetaURI 1; + ~*MFC_Tear_Sample 1; + ~*Microsoft\ URL\ Control 1; + ~*microsoft\.url 1; + ~*MIDown\ tool 1; + ~*MIIxpc 1; + ~*miner 1; + ~*Missigua\ Locator 1; + ~*Mister\ PiX 1; + ~*MJ12bot 1; + ~*Mozilla.*Indy 1; + ~*Mozilla.*NEWT 1; + ~*MSFrontPage 1; + ~*MSIECrawler 1; + ~*msnbot 1; + ~*NAMEPROTECT 1; + ~*Navroad 1; + ~*NearSite 1; + ~*Net\ Vampire 1; + ~*NetAnts 1; + ~*Netcraft 1; + ~*netEstate 1; + ~*NetMechanic 1; + ~*NetSpider 1; + ~*NetZIP 1; + ~*NextGenSearchBot 1; + ~*NICErsPRO 1; + ~*niki\-bot 1; + ~*NimbleCrawler 1; + ~*Nimbostratus\-Bot 1; + ~*Ninja 1; + ~*nmap 1; + ~*Nmap 1; + ~*NPbot 1; + ~*nutch 1; + ~*Octopus 1; + ~*Offline\.Explorer 1; + ~*Offline\.Navigator 1; + ~*Offline\ Explorer 1; + ~*Offline\ Navigator 1; + ~*Openfind 1; + ~*OpenindexSpider 1; + ~*OpenLinkProfiler 1; + ~*OpenWebSpider 1; + ~*OrangeBot 1; + ~*OutfoxBot 1; + ~*Owlin 1; + ~*PageGrabber 1; + ~*PagesInventory 1; + ~*panopta 1; + ~*panscient\.com 1; + ~*Papa\ Foto 1; + ~*pavuk 1; + ~*pcBrowser 1; + ~*PECL\:\:HTTP 1; + ~*PeoplePal 1; + ~*Photon 1; + ~*PHPCrawl 1; + ~*Pixray 1; + ~*planetwork 1; + ~*PleaseCrawl 1; + ~*PNAMAIN\.EXE 1; + ~*Pockey 1; + ~*PodcastPartyBot 1; + ~*prijsbest 1; + ~*probethenet 1; + ~*ProPowerBot 1; + ~*ProWebWalker 1; + ~*proximic 1; + ~*psbot 1; + ~*Pump 1; + ~*purebot 1; + ~*pycurl 1; + ~*python\-requests 1; + ~*QueryN\.Metasearch 1; + ~*QuerySeekerSpider 1; + ~*R6_CommentReader 1; + ~*R6_FeedFetcher 1; + ~*RealDownload 1; + ~*Reaper 1; + ~*Recorder 1; + ~*ReGet 1; + ~*RepoMonkey 1; + ~*Riddler 1; + ~*Ripper 1; + ~*Rippers\ 0 1; + ~*RMA 1; + ~*rogerbot 1; + ~*RSSingBot 1; + ~*rv\:1\.9\.1 1; + ~*RyzeCrawler 1; + ~*SafeSearch 1; + ~*SBIder 1; + ~*scanbot 1; + ~*Scrapy 1; + ~*Screaming 1; + ~*SeaMonkey$ 1; + ~*search_robot 1; + ~*SearchmetricsBot 1; + ~*Semrush 1; + ~*SemrushBot 1; + ~*semrush\.com 1; + ~*SemrushBot-BA 1; + ~*SentiBot 1; + ~*SEOkicks 1; + ~*SEOkicks\-Robot 1; + ~*seoscanners 1; + ~*SeznamBot 1; + ~*ShowyouBot 1; + ~*SightupBot 1; + ~*Siphon 1; + ~*SISTRIX 1; + ~*sitecheck\.internetseer\.com 1; + ~*siteexplorer\.info 1; + ~*Siteimprove 1; + ~*SiteSnagger 1; + ~*SiteSucker 1; + ~*skygrid 1; + ~*Slackbot 1; + ~*Slurp 1; + ~*SlySearch 1; + ~*SmartDownload 1; + ~*Snake 1; + ~*Snapbot 1; + ~*Snoopy 1; + ~*sogou 1; + ~*Sogou 1; + ~*Sosospider 1; + ~*SpaceBison 1; + ~*SpankBot 1; + ~*spanner 1; + ~*spaumbot 1; + ~*spbot 1; + ~*Spinn4r 1; + ~*Sqworm 1; + ~*Steeler 1; + ~*Stripper 1; + ~*sucker 1; + ~*Sucker 1; + ~*SuperBot 1; + ~*Superfeedr 1; + ~*SuperHTTP 1; + ~*SurdotlyBot 1; + ~*Surfbot 1; + ~*suzuran 1; + ~*Szukacz 1; + ~*tAkeOut 1; + ~*Teleport 1; + ~*Teleport\ Pro 1; + ~*Telesoft 1; + ~*The\.Intraformant 1; + ~*TheNomad 1; + ~*TightTwatBot 1; + ~*TinEye 1; + ~*TinEye\-bot 1; + ~*Titan 1; + ~*Toata\ dragostea\ mea\ pentru\ diavola 1; + ~*Toplistbot 1; + ~*trendictionbot 1; + ~*trovitBot 1; + ~*True_Robot 1; + ~*turingos 1; + ~*turnit 1; + ~*TurnitinBot 1; + ~*Twitterbot 1; + ~*URI\:\:Fetch 1; + ~*urllib 1; + ~*URLy\.Warning 1; + ~*Vacuum 1; + ~*Vagabondo 1; + ~*VCI 1; + ~*VidibleScraper 1; + ~*vikspider 1; + ~*VoidEYE 1; + ~*VoilaBot 1; + ~*WallpapersHD 1; + ~*WBSearchBot 1; + ~*Web.Image.Collector 1; + ~*Web\ Image\ Collector 1; + ~*Web\ Sucker 1; + ~*webalta 1; + ~*WebAuto 1; + ~*WebBandit 1; + ~*WebCollage 1; + ~*WebCopier 1; + ~*WebEnhancer 1; + ~*WebFetch 1; + ~*WebFuck 1; + ~*WebGo\ IS 1; + ~*WebLeacher 1; + ~*WebmasterWorldForumBot 1; + ~*WebPix 1; + ~*WebReaper 1; + ~*WebSauger 1; + ~*WebShag 1; + ~*Website\.eXtractor 1; + ~*Website\ eXtractor 1; + ~*Website\ Quester 1; + ~*Webster 1; + ~*WebStripper 1; + ~*WebSucker 1; + ~*WebWhacker 1; + ~*WebZIP 1; + ~*Wells\ Search\ II 1; + ~*WEP\ Search 1; + ~*WeSEE 1; + ~*Wget 1; + ~*Whack 1; + ~*Whacker 1; + ~*Widow 1; + ~*WinHTTrack 1; + ~*WinInet 1; + ~*WISENutbot 1; + ~*woobot 1; + ~*woopingbot 1; + ~*worldwebheritage.org 1; + ~*Wotbox 1; + ~*WPScan 1; + ~*WWW\-Collector\-E 1; + ~*WWW\-Mechanize 1; + ~*WWWOFFLE 1; + ~*Xaldon 1; + ~*Xaldon\ WebSpider 1; + ~*Xenu 1; + ~*XoviBot 1; + ~*yacybot 1; + ~*YisouSpider 1; + ~*Zade 1; + ~*zermelo 1; + ~*Zeus 1; + ~*zh\-CN 1; + ~*ZmEu 1; + ~*ZumBot 1; + ~*Zyborg 1; + ~*ZyBorg 1; + ~*Yandex 1; + ~*YandexBot 1; + ~*Baiduspider 1; + ~*BaiduSpider 1; + ~*Slackbot 1; +} + +map $http_user_agent $bad_bot1 { +default 0; +~*^Lynx 0; # Let Lynx go through +libwww-perl 1; +~*(?i)(80legs|360Spider|Aboundex|AhrefsBot|Daumoa|DataForSeoBot|DaumBot|applebot|BLEXBot|serpstatbot|MediaMathbot|Abonti|Acunetix|^AIBOT|^Alexibot|Alligator|AllSubmitter|Apexoo|^asterias|^attach|^BackDoorBot|^BackStreet|^BackWeb|Badass|Bandit|petalbot|Baid|Baiduspider|^BatchFTP|^Bigfoot|^Black.Hole|^BlackWidow|BlackWidow|^BlowFish|Blow|^BotALot|Buddy|^BuiltBotTough|^Bullseye|^BunnySlippers|BBBike|^Cegbfeieh|^CheeseBot|^CherryPicker|^ChinaClaw|^Cogentbot|CPython|Collector|cognitiveseo|Copier|^CopyRightCheck|^cosmos|^Crescent|CSHttp|^Custo|^Demon|^Devil|^DISCo|^DIIbot|discobot|^DittoSpyder|Download.Demon|Download.Devil|Download.Wonder|^dragonfly|^Drip|^eCatch|^EasyDL|^ebingbong|^EirGrabber|^EmailCollector|^EmailSiphon|^EmailWolf|^EroCrawler|^Exabot|^Express|Extractor|^EyeNetIE|FHscan|^FHscan|^flunky|^Foobot|^FrontPage|GalaxyBot|^gotit|Grabber|^GrabNet|^Grafula|^Harvest|^HEADMasterSEO|^hloader|^HMView|^HTTrack|httrack|HTTrack|htmlparser|^humanlinks|^IlseBot|Image.Stripper|Image.Sucker|imagefetch|^InfoNaviRobot|^InfoTekies|^Intelliseek|^InterGET|^Iria|^Jakarta|^JennyBot|^JetCar|JikeSpider|^JOC|^JustView|^Jyxobot|^Kenjin.Spider|^Keyword.Density|libwww|^larbin|LeechFTP|LeechGet|^LexiBot|^lftp|^libWeb|^likse|^LinkextractorPro|^LinkScan|^LNSpiderguy|^LinkWalker|msnbot|MSIECrawler|MJ12bot|MegaIndex|^Magnet|^Mag-Net|^MarkWatch|Mass.Downloader|masscan|^Mata.Hari|^Memo|^MIIxpc|^NAMEPROTECT|^Navroad|^NearSite|^NetAnts|^Netcraft|^NetMechanic|^NetSpider|^NetZIP|^NextGenSearchBot|^NICErsPRO|^niki-bot|^NimbleCrawler|^Nimbostratus-Bot|^Ninja|^Nmap|nmap|^NPbot|Offline.Explorer|Offline.Navigator|OpenLinkProfiler|^Octopus|^Openfind|^OutfoxBot|Pixray|probethenet|proximic|^PageGrabber|^pavuk|^pcBrowser|^Pockey|^ProPowerBot|^ProWebWalker|^psbot|^Pump|python-requests|^QueryN.Metasearch|^RealDownload|Reaper|^Reaper|^Ripper|Ripper|Recorder|^ReGet|^RepoMonkey|^RMA|scanbot|SEOkicks-Robot|seoscanners|^Stripper|^Sucker|Siphon|Siteimprove|^SiteSnagger|SiteSucker|^SlySearch|^SmartDownload|^Snake|^Snapbot|^Snoopy|Sosospider|^sogou|spbot|^SpaceBison|^spanner|^SpankBot|Spinn4r|^Sqworm|Sqworm|Stripper|Sucker|^SuperBot|SuperHTTP|^SuperHTTP|^Surfbot|^suzuran|^Szukacz|^tAkeOut|^Teleport|^Telesoft|^TurnitinBot|^The.Intraformant|^TheNomad|^TightTwatBot|^Titan|^True_Robot|^turingos|^TurnitinBot|^URLy.Warning|^Vacuum|^VCI|VidibleScraper|^VoidEYE|^WebAuto|^WebBandit|^WebCopier|^WebEnhancer|^WebFetch|^Web.Image.Collector|^WebLeacher|^WebmasterWorldForumBot|WebPix|^WebReaper|^WebSauger|Website.eXtractor|^Webster|WebShag|^WebStripper|WebSucker|^WebWhacker|^WebZIP|Whack|Whacker|^Widow|Widow|WinHTTrack|^WISENutbot|WWWOFFLE|^WWWOFFLE|^WWW-Collector-E|^Xaldon|^Xenu|^Zade|^Zeus|ZmEu|^Zyborg|SemrushBot|^WebFuck|^MJ12bot|^majestic12|^WallpapersHD) 1; +} + +## Add here all referrers that are to blocked. +map $http_referer $bad_referer { +default 0; +~(?i)(adcash|advair|allegra|ambien|amoxicillin|adult|anal|asshole|babes|baccarat|betting|bithack|blackjack|cash|casino|celeb|cheap|cialis|craps|credit|click|cunt|deal|debt|drug|diamond|effexor|equity|faxo|finance|fisting|forsale|gambling|gaysex|girl|hardcore|hold-em|holdem|iconsurf|ilovevitaly|insurance|interest|internetsupervision|jewelry|keno|levitra|lipitor|loan|loans|love|makemoneyonline|make-money-online|meds|money|mortgage|myftpupload|nudit|omaha|organic|paxil|pharmacy|pharmacies|phentermine|pheromone|pills|piss|poker|porn|poweroversoftware|refinance|replica|rimming|roulette|screentoolkit|seoexperimenty|sex|snuff|scout|seventwentyfour|slot|slots|syntryx|teen|texas|t0phackteam|tournament|tramadol|tramidol|valtrex|vvakhrin-ws1|viagra|vicodin|webcam|xanax|xnxx|xxxrus|zanax|zippo|zoloft) 1; +} + +## Add here all bad referer domains to be blocked - broken up into sections +## Alphabetical A - E (incl numbers) +map $http_referer $bad_urls1 { +default 0; +~(?i)(^http://(www\.)?38ha(-|.).*$|^http://(www\.)?4free(-|.).*$|^http://(www\.)?4hs8(-|.).*$|^http://(www\.)?4t(-|.).*$|^http://(www\.)?4u(-|.).*$|^http://(www\.)?6q(-|.).*$|^http://(www\.)?7makemoneyonline(-|.).*$|^http://(www\.)?8gold(-|.).*$|^http://(www\.)?911(-|.).*$|^http://(www\.)?adcash(-|.).*$|^http://(www\.)?.*(-|.)?adult(-|.).*$|^http://(www\.)?.*(-|.)?acunetix-referrer(-|.).*$|^http://(www\.)?abalone(-|.).*$|^http://(www\.)?adminshop(-|.).*$|^http://(www\.)?adultactioncam(-|.).*$|^http://(www\.)?aizzo(-|.).*$|^http://(www\.)?alphacarolinas(-|.).*$|^http://(www\.)?amateur(-|.).*$|^http://(www\.)?amateurxpass(-|.).*$|^http://(www\.)?.*(-|.)?anal(-|.).*$|^http://(www\.)?ansar-u-deen(-|.).*$|^http://(www\.)?atelebanon(-|.).*$|^http://(www\.)?beastiality(-|.).*$|^http://(www\.)?bestiality(-|.).*$|^http://(www\.)?belize(-|.).*$|^http://(www\.)?best-deals(-|.).*$|^http://(www\.)?bithack(-|.).*$|^http://(www\.)?blogincome(-|.).*$|^http://(www\.)?bontril(-|.).*$|^http://(www\.)?bruce-holdeman(-|.).*$|^http://(www\.)?.*(-|.)?blow.?job(-|.).*$|^http://(www\.)?buttons-for-website(-|.).*$|^http://(www\.)?ca-america(-|.).*$|^http://(www\.)?chatt-net(-|.).*$|^http://(www\.)?cenokos(-|.).*$|^http://(www\.)?cenoval(-|.).*$|^http://(www\.)?cityadspix(-|.).*$|^http://(www\.)?commerce(-|.).*$|^http://(www\.)?condo(-|.).*$|^http://(www\.)?conjuratia(-|.).*$|^http://(www\.)?consolidate(-|.).*$|^http://(www\.)?coswap(-|.).*$|^http://(www\.)?crescentarian(-|.).*$|^http://(www\.)?crepesuzette(-|.).*$|^http://(www\.)?darodar(-|.).*$|^http://(www\.)?dating(-|.).*$|^http://(www\.)?devaddict(-|.).*$|^http://(www\.)?discount(-|.).*$|^http://(www\.)?doobu(-|.).*$|^http://(www\.)?domainsatcost(-|.).*$|^http://(www\.)?econom.co(-|.).*$|^http://(www\.)?edakgfvwql(-|.).*$|^http://(www\.)?.*(-|.)?sex(-|.).*$|^http://(www\.)?e-site(-|.).*$|^http://(www\.)?egygift(-|.).*$|^http://(www\.)?empathica(-|.).*$|^http://(www\.)?empirepoker(-|.).*$|^http://(www\.)?e-poker-2005(-|.).*$|^http://(www\.)?escal8(-|.).*$|^http://(www\.)?eurip(-|.).*$|^http://(www\.)?exitq(-|.).*$|^http://(www\.)?eyemagination(-|.).*$) 1; +} +## F - I +map $http_referer $bad_urls2 { +default 0; +~(?i)(^http://(www\.)?fastcrawl(-|.).*$|^http://(www\.)?fearcrow(-|.).*$|^http://(www\.)?ferretsoft(-|.).*$|^http://(www\.)?fick(-|.).*$|^http://(www\.)?finance(-|.).*$|^http://(www\.)?flafeber(-|.).*$|^http://(www\.)?fidelityfunding(-|.).*$|^http://(www\.)?freakycheats(-|.).*$|^http://(www\.)?freeality(-|.).*$|^http://(www\.)?fuck(-|.).*$|^http://(www\.)?future-2000(-|.).*$|^http://(www\.)?.*(-|.)?gay(-|.).*$|^http://(www\.)?gobongo.info(-|.).*$|^http://(www\.)?gabriola(-|.).*$|^http://(www\.)?gallerylisting(-|.).*$|^http://(www\.)?gb.com(-|.).*$|^http://(www\.)?ghostvisitor(-|.).*$|^http://(www\.)?globusy(-|.).*$|^http://(www\.)?golf-e-course(-|.).*$|^http://(www\.)?gospelcom(-|.).*$|^http://(www\.)?gradfinder(-|.).*$|^http://(www\.)?hasfun(-|.).*$|^http://(www\.)?herbal(-|.).*$|^http://(www\.)?hermosa(-|.).*$|^http://(www\.)?highprofitclub(-|.).*$|^http://(www\.)?hilton(-|.).*$|^http://(www\.)?teaminspection(-|.).*$|^http://(www\.)?hotel(-|.).*$|^http://(www\.)?houseofseven(-|.).*$|^http://(www\.)?hurricane(-|.).*$|^http://(www\.)?.*(-|.)?incest(-|.).*$|^http://(www\.)?iaea(-|.).*$|^http://(www\.)?ilovevitality(-|.).*$|^http://(www\.)?ime(-|.).*$|^http://(www\.)?info(-|.).*$|^http://(www\.)?ingyensms(-|.).*$|^http://(www\.)?inkjet-toner(-|.).*$|^http://(www\.)?isacommie(-|.).*$|^http://(www\.)?istarthere(-|.).*$|^http://(www\.)?it.tt(-|.).*$|^http://(www\.)?italiancharms(-|.).*$|^http://(www\.)?iwantu(-|.).*$|^http://(www\.)?ilovevitality(-|.).*$|^http://(www\.)?iskalko.ru(-|.).*$) 1; +} +## J - P +map $http_referer $bad_urls3 { +default 0; +~(?i)(^http://(www\.)?jfcadvocacy(-|.).*$|^http://(www\.)?jmhic(-|.).*$|^http://(www\.)?juris(-|.).*$|^http://(www\.)?kylos(-|.).*$|^http://(www\.)?laser-eye(-|.).*$|^http://(www\.)?leathertree(-|.).*$|^http://(www\.)?lillystar(-|.).*$|^http://(www\.)?linkerdome(-|.).*$|^http://(www\.)?livenet(-|.).*$|^http://(www\.)?low-limit(-|.).*$|^http://(www\.)?lowest-price(-|.).*$|^http://(www\.)?luxup.ru(-|.).*$|^http://(www\.)?macsurfer(-|.).*$|^http://(www\.)?mall.uk(-|.).*$|^http://(www\.)?maloylawn(-|.).*$|^http://(www\.)?marketing(-|.).*$|^http://(www\.)?.*(-|.)?mature(-|.).*$|^http://(www\.)?mcdortaklar(-|.).*$|^http://(www\.)?mediavisor(-|.).*$|^http://(www\.)?medications(-|.).*$|^http://(www\.)?mirror.sytes(-|.).*$|^http://(www\.)?mp3(-|.).*$|^http://(www\.)?(-|.)musicbox1(-|.).*$|^http://(www\.)?myftpupload(-|.).*$|^http://(www\.)?naked(-|.).*$|^http://(www\.)?netdisaster(-|.).*$|^http://(www\.)?netfirms(-|.).*$|^http://(www\.)?newtruths(-|.).*$|^http://(www\.)?no-limit(-|.).*$|^http://(www\.)?nude(-|.).*$|^http://(www\.)?nudeceleb(-|.).*$|^http://(www\.)?nutzu(-|.).*$|^http://(www\.)?odge(-|.).*$|^http://(www\.)?oiline(-|.).*$|^http://(www\.)?onlinegamingassoc(-|.).*$|^http://(www\.)?outpersonals(-|.).*$|^http://(www\.)?o-o-6-o-o.ru(-|.).*$|^http://(www\.)?o-o-8-o-o.ru(-|.).*$|^http://(www\.)?pagetwo(-|.).*$|^http://(www\.)?paris(-|.).*$|^http://(www\.)?passions(-|.).*$|^http://(www\.)?peblog(-|.).*$|^http://(www\.)?peng(-|.).*$|^http://(www\.)?perfume-cologne(-|.).*$|^http://(www\.)?personal(-|.).*$|^http://(www\.)?php-soft(-|.).*$|^http://(www\.)?pisoc(-|.).*$|^http://(www\.)?pisx(-|.).*$|^http://(www\.)?popwow(-|.).*$|^http://(www\.)?porn(-|.).*$|^http://(www\.)?prescriptions(-|.).*$|^http://(www\.)?priceg(-|.).*$|^http://(www\.)?.*(-|.)?pus*y(-|.).*$|^http://(www\.)?printdirectforless(-|.).*$|^http://(www\.)?ps2cool(-|.).*$|^http://(www\.)?psnarones(-|.).*$|^http://(www\.)?psxtreme(-|.).*$) 1; +} +## Q - Z +map $http_referer $bad_urls4 { +default 0; +~(?i)(^http://(www\.)?quality-traffic(-|.).*$|^http://(www\.)?registrarprice(-|.).*$|^http://(www\.)?reliableresults(-|.).*$|^http://(www\.)?rimpim(-|.).*$|^http://(www\.)?ro7kalbe(-|.).*$|^http://(www\.)?rohkalby(-|.).*$|^http://(www\.)?ronnieazza(-|.).*$|^http://(www\.)?rulo.biz(-|.).*$|^http://(www\.)?responsinator(-|.).*$|^http://(www\.)?s5(-|.).*$|^http://(www\.)?samiuls(-|.).*$|^http://(www\.)?savefrom(-|.).*$|^http://(www\.)?savetubevideo.com(-|.).*$|^http://(www\.)?screentoolkit.com(-|.).*$|^http://(www\.)?searchedu(-|.).*$|^http://(www\.)?semalt.com(-|.).*$|^http://(www\.)?seoexperimenty(-|.).*$|^http://(www\.)?seventwentyfour(-|.).*$|^http://(www\.)?seventwentyfour.*$|^http://(www\.)?sex(-|.).*$|^http://(www\.)?sexsearch(-|.).*$|^http://(www\.)?sexsq(-|.).*$|^http://(www\.)?shoesdiscount(-|.).*$|^http://(www\.)?site-4u(-|.).*$|^http://(www\.)?site5(-|.).*$|^http://(www\.)?slatersdvds(-|.).*$|^http://(www\.)?slftsdybbg.ru(-|.).*$|^http://(www\.)?sml338(-|.).*$|^http://(www\.)?sms(-|.).*$|^http://(www\.)?smsportali(-|.).*$|^http://(www\.)?socialseet.ru(-|.).*$|^http://(www\.)?software(-|.).*$|^http://(www\.)?sortthemesitesby(-|.).*$|^http://(www\.)?spears(-|.).*$|^http://(www\.)?spoodles(-|.).*$|^http://(www\.)?sportsparent(-|.).*$|^http://(www\.)?srecorder(-|.).*$|^http://(www\.)?stmaryonline(-|.).*$|^http://(www\.)?superiends.org(-|.).*$|^http://(www\.)?strip(-|.).*$|^http://(www\.)?suttonjames(-|.).*$|^http://(www\.)?talk.uk-yankee(-|.).*$|^http://(www\.)?tecrep-inc(-|.).*$|^http://(www\.)?teen(-|.).*$|^http://(www\.)?terashells(-|.).*$|^http://(www\.)?thatwhichis(-|.).*$|^http://(www\.)?thorcarlson(-|.).*$|^http://(www\.)?.*(-|.)?tits(-|.).*$|^http://(www\.)?.*(-|.)?titten(-|.).*$|^http://(www\.)?tmsathai(-|.).*$|^http://(www\.)?traffixer(-|.).*$|^http://(www\.)?tranny(-|.).*$|^http://(www\.)?valeof(-|.).*$|^http://(www\.)?video(-|.).*$|^http://(www\.)?vinhas(-|.).*$|^http://(www\.)?vixen1(-|.).*$|^http://(www\.)?vpshs(-|.).*$|^http://(www\.)?vrajitor(-|.).*$|^http://(www\.)?vodkoved.ru(-|.).*$|^http://(www\.)?w3md(-|.).*$|^http://(www\.)?websocial.me(-|.).*$|^http://(www\.)?webdevsquare(-|.).*$|^http://(www\.)?whois(-|.).*$|^http://(www\.)?withdrawal(-|.).*$|^http://(www\.)?worldemail(-|.).*$|^http://(www\.)?wslp24(-|.).*$|^http://(www\.)?ws-op(-|.).*$|^http://(www\.)?xnxx(-|.).*$|^http://(www\.)?xopy(-|.).*$|^http://(www\.)?xxx(-|.).*$|^http://(www\.)?yelucie(-|.).*$|^http://(www\.)?youradulthosting(-|.).*$|^http://(www\.)?ykecwqlixx.ru(-|.).*$|^http://(www\.)?yougetsignal.com(-|.).*$|^http://(www\.)?(-|.)zindagi(-|.).*$) 1; +} +## Domains Linked to Yontoo Browser Malware and a Few Other New Ones +## Have split this into it's own section to keep lines shorter NOTE: changes to instructions +## adding if ($bad_urls5) and if ($bad_urls6) to your site(s) config. +map $http_referer $bad_urls5 { +default 0; +~(?i)(^http://(www\.)?101raccoon.ru(-|.).*$|^http://(www\.)?28n2gl3wfyb0.ru(-|.).*$|^http://(www\.)?627ad6438b58439cad1fc8cf6d67a92e.com(-|.).*$|^http://(www\.)?6ab9743d0152486387559b4abaa02ada.com(-|.).*$|^http://(www\.)?a342ae9750004b14b55f7310eff0ab65.com(-|.).*$|^http://(www\.)?aa08daf7e13b6345e09e92f771507fa5f4.com(-|.).*$|^http://(www\.)?aa14ab57a3339c4064bd9ae6fad7495b5f.com(-|.).*$|^http://(www\.)?aa625d84f1587749c1ab011d6f269f7d64.com(-|.).*$|^http://(www\.)?aa81bf391151884adfa3dd677e41f94be1.com(-|.).*$|^http://(www\.)?aa8780bb28a1de4eb5bff33c28a218a930.com(-|.).*$|^http://(www\.)?aa8b68101d388c446389283820863176e7.com(-|.).*$|^http://(www\.)?aa9bd78f328a6a41279d0fad0a88df1901.com(-|.).*$|^http://(www\.)?aa9d046aab36af4ff182f097f840430d51.com(-|.).*$|^http://(www\.)?aaa38852e886ac4af1a3cff9b47cab6272.com(-|.).*$|^http://(www\.)?aab94f698f36684c5a852a2ef272e031bb.com(-|.).*$|^http://(www\.)?aac500b7a15b2646968f6bd8c6305869d7.com(-|.).*$|^http://(www\.)?aac52006ec82a24e08b665f4db2b5013f7.com(-|.).*$|^http://(www\.)?aad1f4acb0a373420d9b0c4202d38d94fa.com(-|.).*$|^http://(www\.)?asrv-a.akamoihd.net(-|.).*$|^http://(www\.)?asrvrep-a.akamaihd.net(-|.).*$|^http://(www\.)?bestpriceninja.com(-|.).*$|^http://(www\.)?bronzeaid-a.akamaihd.net(-|.).*$|^http://(www\.)?browsepulse-a.akamaihd.net(-|.).*$|^http://(www\.)?cashkitten-a.akamaihd.net(-|.).*$|^http://(www\.)?coolbar.pro(-|.).*$) 1; +} +map $http_referer $bad_urls6 { +default 0; +~(?i)(^http://(www\.)?davebestdeals.com(-|.).*$|^http://(www\.)?discovertreasure-a.akamaihd.net(-|.).*$|^http://(www\.)?discovertreasurenow.com(-|.).*$|^http://(www\.)?foxydeal.com(-|.).*$|^http://(www\.)?gameonasia.com(-|.).*$|^http://(www\.)?gameplexcity.com(-|.).*$|^http://(www\.)?gamerextra.com(-|.).*$|^http://(www\.)?gamerscorps.com(-|.).*$|^http://(www\.)?gamewrath.com(-|.).*$|^http://(www\.)?generousdeal-a.akamaihd.net(-|.).*$|^http://(www\.)?girlgamerdaily.com(-|.).*$|^http://(www\.)?hdapp1008-a.akamaihd.net(-|.).*$|^http://(www\.)?highstairs-a.akamaihd.net(-|.).*$|^http://(www\.)?hotshoppymac.com(-|.).*$|^http://(www\.)?matchpal-a.akamaihd.net(-|.).*$|^http://(www\.)?mecash.ru(-|.).*$|^http://(www\.)?monarchfind-a.akamaihd.net(-|.).*$|^http://(www\.)?myshopmatemac.com(-|.).*$|^http://(www\.)?nottyu.xyz(-|.).*$|^http://(www\.)?onlinemegax.com(-|.).*$|^http://(www\.)?outrageousdeal-a.akamaihd.net(-|.).*$|^http://(www\.)?pijoto.net(-|.).*$|^http://(www\.)?recordpage-a.akamaihd.net(-|.).*$|^http://(www\.)?resultshub-a.akamaihd.net(-|.).*$|^http://(www\.)?rvzr-a.akamaihd.net(-|.).*$|^http://(www\.)?savingsslider-a.akamaihd.net(-|.).*$|^http://(www\.)?searchinterneat-a.akamaihd.net(-|.).*$|^http://(www\.)?searchwebknow-a.akamaihd.net(-|.).*$|^http://(www\.)?seeresultshub-a.akamaihd.net(-|.).*$|^http://(www\.)?shoppytoolmac.com(-|.).*$|^http://(www\.)?skytraf.xyz(-|.).*$|^http://(www\.)?splendorsearch-a.akamaihd.net(-|.).*$|^http://(www\.)?strongsignal-a.akamaihd.net(-|.).*$|^http://(www\.)?surfbuyermac.com(-|.).*$|^http://(www\.)?treasuretrack-a.akamaihd.net(-|.).*$|^http://(www\.)?webshoppermac.com(-|.).*$|^http://(www\.)?pospr.waw.pl(-|.).*$|^http://(www\.)?abclauncher.com(-|.).*$|^http://(www\.)?alert-fjg.xyz(-|.).*$|^http://(www\.)?analytics-ads.xyz(-|.).*$|^http://(www\.)?bamo.xsl.pt(-|.).*$|^http://(www\.)?compliance-olga.top(-|.).*$|^http://(www\.)?digital-video-processing.com(-|.).*$|^http://(www\.)?eu-cookie-law.info(-|.).*$|^http://(www\.)?findpik.com(-|.).*$|^http://(www\.)?forum20.smailik.org(-|.).*$|^http://(www\.)?free-share-buttons.top(-|.).*$|^http://(www\.)?free-social-buttons2.xyz(-|.).*$|^http://(www\.)?free-social-buttons3.xyz(-|.).*$|^http://(www\.)?free-social-buttons4.xyz(-|.).*$|^http://(www\.)?free-social-buttons5.xyz(-|.).*$|^http://(www\.)?front.to(-|.).*$|^http://(www\.)?infokonkurs.ru(-|.).*$|^http://(www\.)?mapquestz.us(-|.).*$|^http://(www\.)?quick-offer.com(-|.).*$|^http://(www\.)?rank-checker.online(-|.).*$|^http://(www\.)?rankchecker.online(-|.).*$|^http://(www\.)?rapidokbrain.com(-|.).*$|^http://(www\.)?real-time-analytics.com(-|.).*$|^http://(www\.)?sharebutton.net(-|.).*$|^http://(www\.)?sharebutton.org(-|.).*$|^http://(www\.)?shemale-sex.net(-|.).*$|^http://(www\.)?site-speed-check.site(-|.).*$|^http://(www\.)?site-speed-checker.site(-|.).*$|^http://(www\.)?trafficmania.com(-|.).*$|^http://(www\.)?website-speed-up.site(-|.).*$|^http://(www\.)?website-speed-up.top(-|.).*$|^http://(www\.)?xn--80aagddcgkbcqbad7amllnejg6dya.xn--p1ai(-|.).*$|^http://(www\.)?xn--80aikhbrhr.net(-|.).*$|^http://(www\.)?pila.pl(-|.).*$|^http://(www\.)?dytohqka.su(-|.).*$|^http://(www\.)?fqvjhqciw.net.ru(-|.).*$|^http://(www\.)?wycjrqzy.ua(-|.).*$|^http://(www\.)?0ca29773681c7e82.com(-|.).*$|^http://(www\.)?intervsem.ru(-|.).*$|^http://(www\.)?candy-glam-hp.com(-|.).*$|^http://(www\.)?thecoolimages.net(-|.).*$|^http://(www\.)?rebuildermedical.com(-|.).*$|^http://(www\.)?gaygalls.net(-|.).*$|^http://(www\.)?keywordteam.net(-|.).*$|^http://(www\.)?netfacet.net(-|.).*$|^http://(www\.)?pattersonsweb.com(-|.).*$|^http://(www\.)?trapit.com.gg(-|.).*$) 1; +} +## Add here all hosts that should be spared any referrer checking. +## Whitelist all your own IPs in this section, each IP followed by a 0; +geo $bad_referer { +127.0.0.1 0; +111.111.111.111 0; +} + +# Geo directive to deny certain ip addresses +geo $validate_client { +default 0; + +# Cyveillance +38.100.19.8/29 1; +38.100.21.0/24 1; +38.100.41.64/26 1; +38.105.71.0/25 1; +38.105.83.0/27 1; +38.112.21.140/30 1; +38.118.42.32/29 1; +65.213.208.128/27 1; +65.222.176.96/27 1; +65.222.185.72/29 1; +85.25.176.0/20 1; +85.25.192.0/20 1; +85.25.208.0/22 1; +} \ No newline at end of file diff --git a/config/web-server/nginx/gunicorn/conf.d/default.conf b/config/web-server/nginx/gunicorn/conf.d/default.conf new file mode 100644 index 0000000..a5b1da9 --- /dev/null +++ b/config/web-server/nginx/gunicorn/conf.d/default.conf @@ -0,0 +1,7 @@ +# ip access drop +server { + listen 80; + server_name _; + + return 444; +} diff --git a/config/web-server/nginx/gunicorn/conf.d/django_sample_gunicorn_ng.conf b/config/web-server/nginx/gunicorn/conf.d/django_sample_gunicorn_ng.conf new file mode 100644 index 0000000..68f6e28 --- /dev/null +++ b/config/web-server/nginx/gunicorn/conf.d/django_sample_gunicorn_ng.conf @@ -0,0 +1,62 @@ +server { + listen 80; + server_name localhost www.localhost; + + access_log /log/nginx/django_sample.com.access.log main; + error_log /log/nginx/django_sample.com.error.log warn; + + # Django media + location /media { + gzip_static on; + expires max; + #alias /www/django_sample/django_sample/media; + alias /www/django_sample/media; # your Django project's media files - amend as required + #include /etc/nginx/mime.types; + } + + location /static { + gzip_static on; + expires max; + #alias /www/django_sample/django_sample/static; + # normally static folder is named as /static + alias /www/django_sample/static; # your Django project's static files - amend as required + #include /etc/nginx/mime.types; + } + + location / { + proxy_pass http://gunicorn-app:8000; + # proxy_redirect http:// https://; + + } + + # Allow Lets Encrypt Domain Validation Program + location ^~ /.well-known/acme-challenge/ { + allow all; + root /www/django_sample; + } + + # Block dot file (.htaccess .htpasswd .svn .git .env and so on.) + location ~ /\. { + deny all; + } + + # Block (log file, binary, certificate, shell script, sql dump file) access. + location ~* \.(log|binary|pem|enc|crt|conf|cnf|sql|sh|key|yml|lock)$ { + deny all; + } + + # Block access + location ~* (composer\.json|composer\.lock|composer\.phar|contributing\.md|license\.txt|readme\.rst|readme\.md|readme\.txt|copyright|artisan|gulpfile\.js|package\.json|phpunit\.xml|access_log|error_log|gruntfile\.js)$ { + deny all; + } + + location = /favicon.ico { + log_not_found off; + access_log off; + } + + location = /robots.txt { + log_not_found off; + access_log off; + } +} diff --git a/config/web-server/nginx/gunicorn/nginx_conf.sh b/config/web-server/nginx/gunicorn/nginx_conf.sh new file mode 100644 index 0000000..30cb514 --- /dev/null +++ b/config/web-server/nginx/gunicorn/nginx_conf.sh @@ -0,0 +1,71 @@ +#!/bin/bash + +while : +do + echo "* if your webroot has sub-level, you should be insert as \\\/A\\\/B\\\/C" + echo "ex) shop\\\/django_sample" + echo -n "Enter the service web root without the path of '/www/' >" + read webroot + echo "Entered service web root: $webroot" + if [[ "$webroot" != "" ]]; then + break + fi +done + +while : +do + echo -n "Enter the service portnumber >" + read portnumber + echo "Entered service portnumber: $portnumber" + if [[ "$portnumber" != "" ]]; then + break + fi +done + +while : +do + echo -n "Enter the service domain >" + read domain + echo "Entered service domain: $domain" + if [[ "$domain" != "" ]]; then + break + fi +done + +while : +do + echo -n "Enter the app name >" + read appname + echo "Entered app name: $appname" + if [[ "$appname" != "" ]]; then + break + fi +done + +echo "Enter the serviceport" +echo -n "if you push enter with none, there are no port number >" +read serviceport +echo "Entered proxy port: $serviceport" + +while : +do + echo -n "Enter the file name >" + read filename + echo "Entered file name: $filename" + if [[ "$filename" != "" ]]; then + break + fi +done + +sed 's/webroot/'$webroot'/g' sample_nginx.conf > $filename'1'.temp +sed 's/portnumber/'$portnumber'/g' $filename'1'.temp > $filename'2'.temp +sed 's/domain/'$domain'/g' $filename'2'.temp > $filename'3'.temp +sed 's/appname/'$appname'/g' $filename'3'.temp > $filename'4'.temp +if [[ "$serviceport" == "" ]]; then + sed 's/:serviceport/''/g' $filename'4'.temp > $filename'5'.temp +else + sed 's/serviceport/'$serviceport'/g' $filename'4'.temp > $filename'5'.temp +fi +sed 's/filename/'$filename'/g' $filename'5'.temp > ./conf.d/$filename'_gunicorn_ng'.conf + +rm *.temp diff --git a/config/web-server/nginx/gunicorn/nginx_conf/nginx.conf b/config/web-server/nginx/gunicorn/nginx_conf/nginx.conf new file mode 100644 index 0000000..0f0547a --- /dev/null +++ b/config/web-server/nginx/gunicorn/nginx_conf/nginx.conf @@ -0,0 +1,108 @@ +user www-data; +worker_processes auto; + +# worker_rlimit_nofile directive +# CPU: 쿼드코어, RAM: 4GB, 요청수: ~50/s 기반 설정시 +worker_rlimit_nofile 8192; +# worker_rlimit_nofile 8192; +# worker_priority 0; +# worker_cpu_affinity 0001 0010 0100 1000; + +error_log /var/log/nginx/error.log warn; +pid /var/run/nginx.pid; + + +# Load ModSecurity dynamic module +# load_module /etc/nginx/modules/ngx_http_modsecurity_module.so + +events { + use epoll; # 리눅스에서 권장 + accept_mutex on; # 기본값이지만 명시해두면 좋음 + + # 단일 워커당 동시 연결 수 + # worker_processes * worker_connections = 최대 동시 연결 수 + # 여기에 워커가 상시 쓰는 FD(에러/액세스 로그, 리스닝 소켓, epoll 등) 오버헤드를 조금 빼고 잡아야 안전하다 (약 50~150 정도 버퍼). + + # CPU: 쿼드코어, RAM: 4GB, 요청수: ~50/s 기반 설정시 + # off 설정에 대한 효과 + # 부하 분산: 워커 간 균등한 연결 분배 + # 안정성: 한 워커가 과부하되는 것 방지 + # 예측 가능한 성능: 일관된 응답 시간 + multi_accept off; + worker_connections 1024; +} + + +http { + include /etc/nginx/mime.types; + default_type application/octet-stream; + + log_format main '$remote_addr - $remote_user [$time_local] "$request" ' + '$status $body_bytes_sent "$http_referer" ' + '"$http_user_agent" "$http_x_forwarded_for"'; + + access_log /var/log/nginx/main_access.log main; + error_log /var/log/nginx/main_error.log; + + server_tokens off; + + charset utf-8; + + resolver 8.8.8.8 8.8.4.4 valid=300s; # resolver $DNS-IP-1 $DNS-IP-2 valid=300s; + resolver_timeout 5s; + + # 기본 헤더 버퍼 (대부분의 요청 처리) + client_header_buffer_size 4k; + + # 큰 헤더 버퍼 (JWT, 큰 쿠키 등) + large_client_header_buffers 4 16k; + + # POST나 PUT 요청으로 전송하는 본문(body) 데이터를 받을 때, Nginx가 메모리(RAM)에 임시 저장할 버퍼의 크기 + client_body_buffer_size 128k; # 일반적으로 64KB~256KB 권장 + client_body_timeout 15s; # 클라이언트 본문 수신 타임아웃 + client_header_timeout 15s; # 클라이언트 헤더 수신 타임아웃 + + # 효율적인 파일 전송 설정 + sendfile on; # 커널 공간에서 직접 파일 전송 (제로카피) + tcp_nopush on; # sendfile 사용 시 패킷 효율 향상 + tcp_nodelay on; # Keep-alive 연결에서 지연 없이 전송 (실시간 통신에 유리) + + # Keep-alive 연결 설정 + keepalive_timeout 30s; # 연결 유지 시간 + keepalive_requests 1000; # 연결당 최대 요청 수 + send_timeout 15s; # 클라이언트로 응답 전송 타임아웃 + + # ===== 해시 테이블 ===== + # MIME 타입 해시 테이블 설정 + # mime.types 파일에 정의된 파일 확장자와 MIME 타입 매핑을 저장 + # 예: .html -> text/html, .jpg -> image/jpeg 등의 매핑을 빠르게 찾기 위해 사용됨 + + types_hash_max_size 2048; # 기본 mime.types의 수백 개 타입을 충분히 수용하는 크기 + types_hash_bucket_size 64; # 각 해시 버킷 크기, CPU 캐시 라인과 정렬하여 성능 최적화 + + # 서버 이름 해시 테이블 설정 (server_name 지시자에 정의된 도메인명만 해당) + # server 블록의 server_name 지시자에 설정된 도메인명들을 빠르게 매칭하기 위한 해시 테이블 + server_names_hash_max_size 1024; # 여러 도메인/서브도메인 운영 시 충분한 공간 확보 + server_names_hash_bucket_size 64; # 도메인명 길이를 고려한 버킷 크기 (일반적으로 32~64면 충분) + + # Nginx 변수 해시 테이블 설정 + # $host, $remote_addr 같은 내장 변수와 map/set으로 정의한 커스텀 변수들을 저장하는 해시 테이블 + # HTTP 헤더를 변수로 변환한 $http_* 변수들도 여기에 포함됨 (예: $http_user_agent, $http_referer) + variables_hash_max_size 2048; # 내장 변수 + 커스텀 변수를 위한 충분한 공간 + variables_hash_bucket_size 64; # 변수명 길이와 충돌 방지를 위한 적절한 버킷 크기 + + # ===== 압축 설정 ===== + # 실시간 압축 비활성화 (CPU 부하 감소) + gzip off; + + # 미리 압축된 .gz 파일 제공 + # 예: style.css 요청 시 → style.css.gz 파일을 찾아서 전송 + gzip_static on; + + # Vary: Accept-Encoding 헤더 추가 (프록시 캐시 호환성) + gzip_vary on; + + include /etc/nginx/proxy_params/*; + include /etc/nginx/conf.d/*.conf; + include /etc/nginx/sites-enabled/*.conf; +} diff --git a/config/web-server/nginx/gunicorn/nginx_https_conf.sh b/config/web-server/nginx/gunicorn/nginx_https_conf.sh new file mode 100644 index 0000000..63acab5 --- /dev/null +++ b/config/web-server/nginx/gunicorn/nginx_https_conf.sh @@ -0,0 +1,71 @@ +#!/bin/bash + +while : +do + echo "* if your webroot has sub-level, you should be insert as \\\/A\\\/B\\\/C" + echo "ex) shop\\\/django_sample" + echo -n "Enter the service web root without the path of '/www/' >" + read webroot + echo "Entered service web root: $webroot" + if [[ "$webroot" != "" ]]; then + break + fi +done + +while : +do + echo -n "Enter the service portnumber >" + read portnumber + echo "Entered service portnumber: $portnumber" + if [[ "$portnumber" != "" ]]; then + break + fi +done + +while : +do + echo -n "Enter the service domain >" + read domain + echo "Entered service domain: $domain" + if [[ "$domain" != "" ]]; then + break + fi +done + +while : +do + echo -n "Enter the app name >" + read appname + echo "Entered app name: $appname" + if [[ "$appname" != "" ]]; then + break + fi +done + +echo "Enter the serviceport" +echo -n "if you push enter with none, there are no port number >" +read serviceport +echo "Entered proxy port: $serviceport" + +while : +do + echo -n "Enter the file name >" + read filename + echo "Entered file name: $filename" + if [[ "$filename" != "" ]]; then + break + fi +done + +sed 's/webroot/'$webroot'/g' sample_nginx_https.conf > $filename'1'.temp +sed 's/portnumber/'$portnumber'/g' $filename'1'.temp > $filename'2'.temp +sed 's/domain/'$domain'/g' $filename'2'.temp > $filename'3'.temp +sed 's/appname/'$appname'/g' $filename'3'.temp > $filename'4'.temp +if [[ "$serviceport" == "" ]]; then + sed 's/:serviceport/''/g' $filename'4'.temp > $filename'5'.temp +else + sed 's/serviceport/'$serviceport'/g' $filename'4'.temp > $filename'5'.temp +fi +sed 's/filename/'$filename'/g' $filename'5'.temp > ./conf.d/$filename'_gunicorn_https_ng'.conf + +rm *.temp diff --git a/config/web-server/nginx/gunicorn/proxy_params/proxy_params b/config/web-server/nginx/gunicorn/proxy_params/proxy_params new file mode 100644 index 0000000..34f3573 --- /dev/null +++ b/config/web-server/nginx/gunicorn/proxy_params/proxy_params @@ -0,0 +1,17 @@ +proxy_set_header Host $http_host; +proxy_set_header X-Real-IP $remote_addr; +proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; +proxy_set_header X-Forwarded-Proto $scheme; +proxy_set_header Upgrade $http_upgrade; +proxy_set_header Connection "Upgrade"; +proxy_set_header Connection keep-alive; + +proxy_cache_bypass $http_upgrade; +proxy_buffering off; +proxy_redirect off; +proxy_connect_timeout 90; +proxy_send_timeout 90; +proxy_read_timeout 90; +proxy_buffers 32 4k; +proxy_headers_hash_max_size 512; +proxy_headers_hash_bucket_size 64; diff --git a/config/web-server/nginx/gunicorn/report.md b/config/web-server/nginx/gunicorn/report.md new file mode 100644 index 0000000..c170194 --- /dev/null +++ b/config/web-server/nginx/gunicorn/report.md @@ -0,0 +1,774 @@ +# Nginx HTTPS 설정 검토 보고서 + +## 요약 + +본 보고서는 `sample_nginx_https.conf` (템플릿)와 `https.conf` (code.devspoon.com의 운영 설정)을 비교하고, 현재 설정의 운영 준비 상태를 평가합니다. + +**종합 평가**: `https.conf`는 샘플 템플릿보다 훨씬 더 운영 환경에 적합하며, 최신 보안 헤더와 우수한 설정을 갖추고 있습니다. 그러나 일부 개선 사항이 권장됩니다. + +--- + +## 1. 설정 비교 분석 + +### 1.1 HTTP 서버 블록 (포트 80) + +#### 샘플 설정의 문제점: +```nginx +server { + listen portnumber; + server_name domain www.domain; + + rewrite ^ https://$host$request_uri permanent; + + # if ($host !~* ^(domain\.com|www\.domain\.com)$) { + # return 444; + # } +} +``` + +**문제점:** +- 일반적인 플레이스홀더 사용 (`portnumber`, `domain`) +- `return 301` 대신 더 이상 권장되지 않는 `rewrite` 지시어 사용 +- 호스트 검증이 주석 처리됨 +- Let's Encrypt ACME 챌린지 location 누락 + +#### 운영 설정 (https.conf) - 올바름: +```nginx +server { + listen 80; + server_name code.devspoon.com www.code.devspoon.com; + + # 리다이렉트 전 호스트 검증 + if ($host !~* ^(code\.devspoon\.com|www\.code\.devspoon\.com)$) { + return 444; + } + + # 리다이렉트 전 ACME 챌린지 + location ^~ /.well-known/acme-challenge/ { + allow all; + root /www/certbot; + try_files $uri =404; + } + + # HTTPS로 리다이렉트 + location / { + return 301 https://$server_name$request_uri; + } +} +``` + +**장점:** +✅ `return 301` 사용 (rewrite보다 효율적) +✅ 호스트 검증 활성화 +✅ 리다이렉트 전 ACME 챌린지 적절히 처리 +✅ location 블록으로 더 나은 구조 +✅ `$host` 대신 `$server_name` 사용 (더 안전함) + +--- + +### 1.2 HTTPS 서버 블록 (포트 443) + +#### SSL/TLS 설정 + +**샘플 설정 - 구식:** +```nginx +ssl_protocols TLSv1.2 TLSv1.3; +ssl_prefer_server_ciphers on; +ssl_ciphers 'EECDH+AESGCM:EDH+AESGCM:AES256+EECDH:AES256+EDH'; +``` + +**운영 설정 - 최신 & 올바름:** +```nginx +ssl_protocols TLSv1.2 TLSv1.3; +ssl_prefer_server_ciphers off; # TLSv1.3에서는 OFF +ssl_ciphers ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384; +``` + +**분석:** +- ✅ 운영 설정에서 `ssl_prefer_server_ciphers off` 사용 - TLSv1.3에 **올바름** (클라이언트 선호가 더 나음) +- ✅ 일반적인 약칭 대신 명시적이고 최신 암호화 스위트 사용 +- ✅ 모바일 장치 최적화를 위한 CHACHA20-POLY1305 포함 + +--- + +### 1.3 보안 헤더 + +**샘플 설정 - 누락:** +- 보안 헤더가 전혀 없음 + +**운영 설정 - 우수:** +```nginx +add_header Strict-Transport-Security "max-age=31536000; includeSubDomains; preload" always; +add_header X-Frame-Options DENY always; +add_header X-Content-Type-Options nosniff always; +add_header X-XSS-Protection "1; mode=block" always; +add_header Referrer-Policy "strict-origin-when-cross-origin" always; +add_header Content-Security-Policy "default-src 'self'; script-src 'self' 'unsafe-inline' 'unsafe-eval'; style-src 'self' 'unsafe-inline'; img-src 'self' data: https:; font-src 'self' data:; connect-src 'self' wss: ws:;" always; +``` + +**평가:** +✅ **HSTS** (preload 포함) - 다운그레이드 공격 방지 +✅ **X-Frame-Options** - 클릭재킹 방지 +✅ **X-Content-Type-Options** - MIME 스니핑 방지 +✅ **X-XSS-Protection** - 레거시 XSS 보호 +✅ **Referrer-Policy** - 리퍼러 정보 제어 +✅ **CSP** - XSS 방지를 위한 콘텐츠 보안 정책 +✅ 모든 헤더에 `always` 플래그 사용 - 오류 응답에도 헤더 보장 + +--- + +### 1.4 OCSP 스테이플링 + +**샘플 설정 - 누락** + +**운영 설정 - 구현됨:** +```nginx +ssl_stapling on; +ssl_stapling_verify on; +ssl_trusted_certificate /etc/letsencrypt/live/code.devspoon.com/chain.pem; +resolver 1.1.1.1 8.8.8.8 valid=300s; +resolver_timeout 5s; +``` + +**평가:** +✅ OCSP 스테이플링으로 SSL 핸드셰이크 성능 향상 +✅ Cloudflare (1.1.1.1)와 Google (8.8.8.8) DNS 리졸버 사용 +✅ OCSP 경고에 대한 유용한 주석 포함 + +--- + +### 1.5 프록시 설정 + +**샘플 설정 - 기본:** +```nginx +location / { + autoindex off; + proxy_pass http://appname:serviceport; + proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; + proxy_set_header Host $host; +} +``` + +**운영 설정 - 포괄적:** +```nginx +location / { + proxy_pass http://code-server:8443; + + # WebSocket 지원 + proxy_http_version 1.1; + proxy_set_header Upgrade $http_upgrade; + proxy_set_header Connection "upgrade"; + + # 완전한 프록시 헤더 + proxy_set_header Host $host; + proxy_set_header X-Real-IP $remote_addr; + proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; + proxy_set_header X-Forwarded-Proto $scheme; + proxy_set_header X-Forwarded-Host $host; + proxy_set_header X-Forwarded-Port $server_port; + + # 최적화된 타임아웃 + proxy_connect_timeout 60s; + proxy_send_timeout 60s; + proxy_read_timeout 60s; + + # 버퍼 설정 + proxy_buffering off; + proxy_request_buffering off; + + proxy_set_header Accept-Encoding gzip; +} +``` + +**평가:** +✅ WebSocket 지원 (code-server에 필수) +✅ 포괄적인 forwarded 헤더 +✅ 적절한 타임아웃 설정 +✅ 대화형 애플리케이션에 최적화된 버퍼 설정 +⚠️ 샘플에는 WebSocket 지원이 완전히 없음 + +--- + +### 1.6 정적 파일 처리 + +**샘플 설정 - 존재:** +```nginx +location /media { + autoindex off; + gzip_static on; + expires max; + alias /www/webroot/media; +} + +location /static { + autoindex off; + gzip_static on; + expires max; + alias /www/webroot/static; +} +``` + +**운영 설정 - 누락:** +- /media 또는 /static location 없음 + +**평가:** +⚠️ **누락** - 애플리케이션이 정적 파일을 제공하는 경우 `https.conf`에 추가해야 함 +ℹ️ code-server의 경우, 내부적으로 정적 파일을 처리하므로 의도적일 수 있음 +⚠️ **권장사항**: Django/Flask 백엔드를 추가하는 경우 정적 파일 location 포함 + +--- + +### 1.7 Let's Encrypt ACME 챌린지 + +**샘플 설정:** +```nginx +location ^~ /.well-known/acme-challenge/ { + allow all; + root /www/webroot; +} +``` + +**운영 설정:** +```nginx +location ^~ /.well-known/acme-challenge/ { + allow all; + root /www/certbot; + try_files $uri =404; # 보안 추가 +} +``` + +**평가:** +✅ 운영 설정에 `try_files $uri =404` 추가 - 디렉토리 순회 방지 +✅ 전용 `/www/certbot` 디렉토리 사용 + +--- + +### 1.8 보안 블록 Location + +**샘플 설정:** +```nginx +location ~ /\. { + deny all; +} + +location ~* \.(log|binary|pem|enc|crt|conf|cnf|sql|sh|key|yml|lock)$ { + deny all; +} + +location ~* (composer\.json|...) { + deny all; +} +``` + +**운영 설정 - 향상됨:** +```nginx +location ~ /\. { + deny all; + access_log off; # 차단된 시도는 로그에 남기지 않음 + log_not_found off; +} + +location ~* \.(log|binary|pem|enc|crt|conf|cnf|sql|sh|key|yml|lock)$ { + deny all; + access_log off; + log_not_found off; +} + +location ~* (composer\.json|...) { + deny all; + access_log off; + log_not_found off; +} +``` + +**평가:** +✅ 운영 설정에서 차단된 요청에 대한 로깅 비활성화 - 로그 노이즈 감소 +✅ 스캐너 시도를 로그에 남기지 않아 성능 향상 + +--- + +## 2. https.conf에 누락된 운영 준비 기능 + +### 2.1 속도 제한 - **누락** + +**권장사항: 추가** +```nginx +# http 블록 또는 server 블록에 추가 +limit_req_zone $binary_remote_addr zone=general:10m rate=10r/s; +limit_req_zone $binary_remote_addr zone=api:10m rate=30r/s; +limit_conn_zone $binary_remote_addr zone=addr:10m; + +# location 블록에 +location / { + limit_req zone=general burst=20 nodelay; + limit_conn addr 10; + ... +} +``` + +**영향:** DDoS 및 무차별 대입 공격으로부터 보호 + +--- + +### 2.2 클라이언트 본문 크기 제한 - **누락** + +**권장사항: 추가** +```nginx +client_max_body_size 10M; # 애플리케이션 요구사항에 따라 조정 +client_body_buffer_size 128k; +client_body_timeout 60s; +``` + +**영향:** 메모리 고갈 공격 방지 + +--- + +### 2.3 연결 제한 - **누락** + +**권장사항: 추가** +```nginx +keepalive_timeout 65; +keepalive_requests 100; +send_timeout 60s; +``` + +**영향:** 더 나은 리소스 관리 + +--- + +### 2.4 Gzip 압축 - **누락** + +**권장사항: 추가** +```nginx +gzip on; +gzip_vary on; +gzip_proxied any; +gzip_comp_level 6; +gzip_types text/plain text/css text/xml text/javascript application/json application/javascript application/xml+rss application/rss+xml font/truetype font/opentype application/vnd.ms-fontobject image/svg+xml; +gzip_disable "msie6"; +``` + +**영향:** 대역폭 사용량을 크게 감소 + +--- + +### 2.5 오류 페이지 - **누락** + +**권장사항: 추가** +```nginx +error_page 404 /404.html; +error_page 500 502 503 504 /50x.html; + +location = /404.html { + internal; + root /www/error_pages; +} + +location = /50x.html { + internal; + root /www/error_pages; +} +``` + +**영향:** 더 나은 사용자 경험 및 정보 노출 방지 + +--- + +### 2.6 요청 메서드 제한 - **누락** + +**권장사항: 추가** +```nginx +location / { + limit_except GET POST HEAD OPTIONS { + deny all; + } + ... +} +``` + +**영향:** HTTP 동사 변조 공격 방지 + +--- + +### 2.7 버전 정보 숨김 - **누락** + +**권장사항: 추가** (http 블록에) +```nginx +server_tokens off; +more_clear_headers 'Server'; +more_clear_headers 'X-Powered-By'; +``` + +**영향:** 정보 노출 감소 + +--- + +## 3. SSL/TLS 모범 사례 검증 + +### 현재 설정 평가: + +| 설정 | 현재 값 | 상태 | 권장사항 | +|------|---------|------|----------| +| ssl_protocols | TLSv1.2 TLSv1.3 | ✅ 올바름 | 현재 유지 | +| ssl_prefer_server_ciphers | off | ✅ 올바름 | 유지 (TLSv1.3 모범 사례) | +| ssl_session_cache | shared:SSL:20m | ✅ 좋음 | 트래픽이 많으면 50m 고려 | +| ssl_session_timeout | 10m | ✅ 좋음 | 현재 유지 | +| ssl_session_tickets | off | ✅ 올바름 | 유지 (더 나은 보안) | +| ssl_stapling | on | ✅ 올바름 | 현재 유지 | +| ssl_dhparam | 4096-bit | ✅ 우수 | 현재 유지 | +| HSTS max-age | 31536000 | ✅ 올바름 | 유지 (1년) | + +--- + +## 4. 성능 최적화 격차 + +### 4.1 캐싱 헤더 누락 + +**권장사항: 추가** +```nginx +location ~* \.(jpg|jpeg|png|gif|ico|css|js|woff|woff2|ttf|svg)$ { + expires 1y; + add_header Cache-Control "public, immutable"; + access_log off; +} +``` + +### 4.2 열린 파일 캐시 누락 + +**권장사항: 추가** +```nginx +open_file_cache max=1000 inactive=20s; +open_file_cache_valid 30s; +open_file_cache_min_uses 2; +open_file_cache_errors on; +``` + +--- + +## 5. 로깅 개선 + +### 현재 설정: +```nginx +access_log /log/nginx/code.devspoon.com.nginx.log main; +error_log /log/nginx/code.devspoon.com.nginx_error.log warn; +``` + +**권장사항:** +```nginx +# I/O 감소를 위한 버퍼 추가 +access_log /log/nginx/code.devspoon.com.nginx.log main buffer=32k flush=5s; +error_log /log/nginx/code.devspoon.com.nginx_error.log warn; + +# 더 많은 세부 정보를 포함한 로그 형식 추가 +log_format detailed '$remote_addr - $remote_user [$time_local] ' + '"$request" $status $body_bytes_sent ' + '"$http_referer" "$http_user_agent" ' + '$request_time $upstream_response_time ' + '$upstream_addr $upstream_status'; +``` + +--- + +## 6. 권장 최종 설정 구조 + +```nginx +# HTTP 블록 (포트 80) +server { + listen 80; + server_name code.devspoon.com www.code.devspoon.com; + + # 호스트 검증 + if ($host !~* ^(code\.devspoon\.com|www\.code\.devspoon\.com)$) { + return 444; + } + + # ACME 챌린지 + location ^~ /.well-known/acme-challenge/ { + allow all; + root /www/certbot; + try_files $uri =404; + } + + # HTTPS로 리다이렉트 + location / { + return 301 https://$server_name$request_uri; + } +} + +# HTTPS 블록 (포트 443) +server { + listen 443 ssl; + http2 on; + server_name code.devspoon.com www.code.devspoon.com; + + # SSL 인증서 + ssl_certificate /etc/letsencrypt/live/code.devspoon.com/fullchain.pem; + ssl_certificate_key /etc/letsencrypt/live/code.devspoon.com/privkey.pem; + ssl_dhparam /etc/ssl/certs/code.devspoon.com/dhparam.pem; + + # 최신 SSL 설정 + ssl_session_cache shared:SSL:50m; + ssl_session_timeout 10m; + ssl_session_tickets off; + ssl_protocols TLSv1.2 TLSv1.3; + ssl_prefer_server_ciphers off; + ssl_ciphers ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384; + ssl_ecdh_curve secp384r1; + + # OCSP 스테이플링 + ssl_stapling on; + ssl_stapling_verify on; + ssl_trusted_certificate /etc/letsencrypt/live/code.devspoon.com/chain.pem; + resolver 1.1.1.1 8.8.8.8 valid=300s; + resolver_timeout 5s; + + # 보안 헤더 + add_header Strict-Transport-Security "max-age=31536000; includeSubDomains; preload" always; + add_header X-Frame-Options DENY always; + add_header X-Content-Type-Options nosniff always; + add_header X-XSS-Protection "1; mode=block" always; + add_header Referrer-Policy "strict-origin-when-cross-origin" always; + add_header Content-Security-Policy "default-src 'self'; script-src 'self' 'unsafe-inline' 'unsafe-eval'; style-src 'self' 'unsafe-inline'; img-src 'self' data: https:; font-src 'self' data:; connect-src 'self' wss: ws:;" always; + + # 신규: 보안 설정 + server_tokens off; + client_max_body_size 10M; + client_body_buffer_size 128k; + client_body_timeout 60s; + + # 신규: 성능 설정 + keepalive_timeout 65; + keepalive_requests 100; + send_timeout 60s; + + # 신규: Gzip 압축 + gzip on; + gzip_vary on; + gzip_proxied any; + gzip_comp_level 6; + gzip_types text/plain text/css text/xml text/javascript application/json application/javascript application/xml+rss; + + # 신규: 파일 캐시 + open_file_cache max=1000 inactive=20s; + open_file_cache_valid 30s; + open_file_cache_min_uses 2; + open_file_cache_errors on; + + # 버퍼링을 사용한 로깅 + access_log /log/nginx/code.devspoon.com.nginx.log main buffer=32k flush=5s; + error_log /log/nginx/code.devspoon.com.nginx_error.log warn; + + # 호스트 검증 + if ($host !~* ^(code\.devspoon\.com|www\.code\.devspoon\.com)$) { + return 444; + } + + # 나쁜 봇 차단 + if ($bad_bot) { + return 403; + } + + # 메인 애플리케이션 + location / { + # 신규: 속도 제한 + limit_req zone=general burst=20 nodelay; + limit_conn addr 10; + + # 신규: 메서드 제한 + limit_except GET POST HEAD OPTIONS { + deny all; + } + + proxy_pass http://code-server:8443; + + # WebSocket 지원 + proxy_http_version 1.1; + proxy_set_header Upgrade $http_upgrade; + proxy_set_header Connection "upgrade"; + + # 프록시 헤더 + proxy_set_header Host $host; + proxy_set_header X-Real-IP $remote_addr; + proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; + proxy_set_header X-Forwarded-Proto $scheme; + proxy_set_header X-Forwarded-Host $host; + proxy_set_header X-Forwarded-Port $server_port; + + # 타임아웃 + proxy_connect_timeout 60s; + proxy_send_timeout 60s; + proxy_read_timeout 60s; + + # 버퍼 설정 + proxy_buffering off; + proxy_request_buffering off; + proxy_set_header Accept-Encoding gzip; + } + + # ACME 챌린지 + location ^~ /.well-known/acme-challenge/ { + allow all; + root /www/certbot; + try_files $uri =404; + } + + # 신규: 정적 파일 캐싱 (필요시) + location ~* \.(jpg|jpeg|png|gif|ico|css|js|woff|woff2|ttf|svg)$ { + expires 1y; + add_header Cache-Control "public, immutable"; + access_log off; + } + + # 닷 파일 차단 + location ~ /\. { + deny all; + access_log off; + log_not_found off; + } + + # 민감한 파일 차단 + location ~* \.(log|binary|pem|enc|crt|conf|cnf|sql|sh|key|yml|lock)$ { + deny all; + access_log off; + log_not_found off; + } + + # 민감한 설정 파일 차단 + location ~* (composer\.json|composer\.lock|composer\.phar|contributing\.md|license\.txt|readme\.rst|readme\.md|readme\.txt|copyright|artisan|gulpfile\.js|package\.json|phpunit\.xml|access_log|error_log|gruntfile\.js)$ { + deny all; + access_log off; + log_not_found off; + } + + # 파비콘 및 robots + location = /favicon.ico { + log_not_found off; + access_log off; + } + + location = /robots.txt { + log_not_found off; + access_log off; + allow all; + } +} +``` + +--- + +## 7. 우선순위 실행 항목 + +### 긴급 (즉시 구현) +1. ✅ **이미 존재**: 보안 헤더 (HSTS, CSP 등) +2. ✅ **이미 존재**: OCSP 스테이플링 +3. ⚠️ **추가**: 속도 제한 설정 +4. ⚠️ **추가**: `server_tokens off` +5. ⚠️ **추가**: `client_max_body_size` 제한 + +### 높은 우선순위 (권장) +6. ⚠️ **추가**: Gzip 압축 +7. ⚠️ **추가**: 열린 파일 캐시 +8. ⚠️ **추가**: 오류 페이지 처리 +9. ⚠️ **추가**: HTTP 메서드 제한 +10. ⚠️ **추가**: 로깅 버퍼 설정 + +### 중간 우선순위 (선택 사항) +11. ⚠️ **추가**: 정적 파일 캐싱 헤더 +12. ⚠️ **고려**: SSL 세션 캐시 크기 증가 +13. ⚠️ **고려**: 향상된 로깅 형식 +14. ⚠️ **검토**: 특정 애플리케이션 요구사항에 맞는 CSP 정책 + +--- + +## 8. 설정 의존성 + +### nginx.conf (http 블록)에 필요: +```nginx +# 서버 블록 전에 정의되어야 함 +limit_req_zone $binary_remote_addr zone=general:10m rate=10r/s; +limit_conn_zone $binary_remote_addr zone=addr:10m; + +# 나쁜 봇 탐지 맵 +map $http_user_agent $bad_bot { + default 0; + ~*malicious 1; + ~*scrapy 1; + ~*bot 1; + ~*crawler 1; +} + +# WebSocket 업그레이드 맵 +map $http_upgrade $connection_upgrade { + default upgrade; + '' close; +} + +# 로그 형식 +log_format main '$remote_addr - $remote_user [$time_local] "$request" ' + '$status $body_bytes_sent "$http_referer" ' + '"$http_user_agent" "$http_x_forwarded_for"'; +``` + +--- + +## 9. SSL/TLS 테스트 권장사항 + +변경 사항 구현 후 다음으로 테스트: + +1. **SSL Labs**: https://www.ssllabs.com/ssltest/ + - 목표 등급: A+ + +2. **Mozilla Observatory**: https://observatory.mozilla.org/ + - 목표 점수: A+ 또는 100+ + +3. **Security Headers**: https://securityheaders.com/ + - 목표 등급: A+ + +4. **OpenSSL CLI**: + ```bash + openssl s_client -connect code.devspoon.com:443 -tls1_2 + openssl s_client -connect code.devspoon.com:443 -tls1_3 + ``` + +--- + +## 10. 요약 + +### https.conf에서 이미 우수한 점: +✅ 최신 SSL/TLS 설정 +✅ 포괄적인 보안 헤더 +✅ OCSP 스테이플링 +✅ WebSocket 지원 +✅ 적절한 ACME 챌린지 처리 +✅ 향상된 프록시 설정 +✅ 로깅 최적화가 적용된 보안 블록 location + +### 추가해야 할 사항: +⚠️ 속도 제한 +⚠️ 클라이언트 본문 크기 제한 +⚠️ Gzip 압축 +⚠️ 열린 파일 캐시 +⚠️ 서버 토큰 숨김 +⚠️ 오류 페이지 처리 +⚠️ HTTP 메서드 제한 + +### 결론: +**https.conf는 sample_nginx_https.conf보다 훨씬 우수하며** 최신 모범 사례를 따릅니다. 샘플 파일은 구식이고 중요한 보안 기능이 누락되어 있습니다. 위의 권장 추가 사항을 적용하면 `https.conf`는 운영 등급의 엔터프라이즈 준비 nginx 설정이 될 것입니다. + +--- + +## 11. 다음 단계 + +1. 긴급 우선순위 항목 검토 및 구현 +2. 설정 테스트: `nginx -t` +3. 변경 사항 적용 전 현재 설정 백업 +4. 변경 사항을 점진적으로 적용 +5. 문제가 있는지 로그 모니터링 +6. A+ 등급 확인을 위한 SSL/TLS 테스트 실행 +7. 속도 제한 및 성능 메트릭 모니터링 설정 + +--- + +**보고서 생성**: sample_nginx_https.conf vs https.conf 비교 기반 +**기준선**: https.conf (code.devspoon.com의 운영 설정) +**평가**: 권장 개선 사항을 포함한 운영 준비 완료 diff --git a/config/web-server/nginx/gunicorn/sample_nginx.conf b/config/web-server/nginx/gunicorn/sample_nginx.conf new file mode 100644 index 0000000..be171d5 --- /dev/null +++ b/config/web-server/nginx/gunicorn/sample_nginx.conf @@ -0,0 +1,73 @@ +server { + listen portnumber; + server_name domain www.domain; + + if ($bad_bot) { + return 403; + } + + access_log /log/nginx/filename.com.gunicorn_access.log main; + error_log /log/nginx/filename.com.gunicorn_error.log warn; + + # if ($host !~* ^(domain\.com|www\.domain\.com)$) { + # return 444; + # } + + # Django media + location /media { + autoindex off; + gzip_static on; + expires max; + #alias /www/django_sample/media; + alias /www/webroot/media; # your Django project's media files - amend as required + #include /etc/nginx/mime.types; + } + + location /static { + autoindex off; + gzip_static on; + expires max; + #alias /www/django_sample/static; + # normally static folder is named as /static + alias /www/webroot/static; # your Django project's static files - amend as required + #include /etc/nginx/mime.types; + } + + location / { + autoindex off; + proxy_pass http://appname:serviceport; + # proxy_redirect http:// https://; + + } + + # Allow Lets Encrypt Domain Validation Program + location ^~ /.well-known/acme-challenge/ { + allow all; + root /www/webroot; + } + + # Block dot file (.htaccess .htpasswd .svn .git .env and so on.) + location ~ /\. { + deny all; + } + + # Block (log file, binary, certificate, shell script, sql dump file) access. + location ~* \.(log|binary|pem|enc|crt|conf|cnf|sql|sh|key|yml|lock)$ { + deny all; + } + + # Block access + location ~* (composer\.json|composer\.lock|composer\.phar|contributing\.md|license\.txt|readme\.rst|readme\.md|readme\.txt|copyright|artisan|gulpfile\.js|package\.json|phpunit\.xml|access_log|error_log|gruntfile\.js)$ { + deny all; + } + + location = /favicon.ico { + log_not_found off; + access_log off; + } + + location = /robots.txt { + log_not_found off; + access_log off; + } +} diff --git a/config/web-server/nginx/gunicorn/sample_nginx_https.conf b/config/web-server/nginx/gunicorn/sample_nginx_https.conf new file mode 100644 index 0000000..3d206e2 --- /dev/null +++ b/config/web-server/nginx/gunicorn/sample_nginx_https.conf @@ -0,0 +1,232 @@ +# =============================================== +# Production Level Nginx Configuration (Sample Template) +# 서버 사양: 쿼드코어 CPU, 4GB RAM, ~50 req/s +# 백엔드: FastAPI REST API Server +# =============================================== + +# HTTP 서버 블록 (포트 80) - HTTPS로 리다이렉트 +server { + listen 80; + server_name domain www.domain; + + # 보안을 위한 호스트 검증 - 허용되지 않은 도메인 차단 + # 도메인 확장자가 다르다면 추가해줘야함 + if ($host !~* ^(www\.)?domain\.(com|kr|net|org)$) { + return 444; + } + + # Let's Encrypt 도메인 검증 프로그램 허용 (리다이렉트 전에 처리) + # SSL 인증서 갱신을 위해 필수 + location ^~ /.well-known/acme-challenge/ { + allow all; + root /www/certbot; + try_files $uri =404; # 디렉토리 순회 공격 방지 + } + + # HTTP를 HTTPS로 리다이렉트 (acme-challenge 제외) + # return 301은 rewrite보다 효율적이며 $server_name이 $host보다 안전함 + location / { + return 301 https://$server_name$request_uri; + } +} + +# HTTPS 서버 블록 (포트 443) - 메인 애플리케이션 +server { + listen 443 ssl http2; + server_name domain.com www.domain.com; + + # 악성 봇 차단 (nginx.conf의 http 블록에서 $bad_bot 맵 정의 필요) + if ($bad_bot) { + return 403; + } + + # SSL/TLS 인증서 설정 + ssl_certificate /etc/letsencrypt/live/domain/fullchain.pem; + ssl_certificate_key /etc/letsencrypt/live/domain/privkey.pem; + ssl_dhparam /etc/ssl/certs/domain/dhparam.pem; # openssl dhparam -out /etc/ssl/certs/domain/dhparam.pem 2048 + + # 최신 SSL/TLS 설정 - SSL Labs A+ 등급 달성 가능 + ssl_session_cache shared:SSL:50m; # SSL 세션 캐시 크기 증가 (트래픽 많을 시 유용) + ssl_session_timeout 10m; # SSL 세션 타임아웃 + ssl_session_tickets off; # 보안 향상을 위해 세션 티켓 비활성화 (nginx >= 1.5.9) + ssl_protocols TLSv1.2 TLSv1.3; # 최신 TLS 프로토콜만 사용 + ssl_prefer_server_ciphers off; # TLSv1.3에서는 클라이언트 선호 암호화 사용 (모범 사례) + # 최신 암호화 스위트 - CHACHA20-POLY1305 포함 (모바일 최적화) + ssl_ciphers "ECDHE-ECDSA-AES128-GCM-SHA256:ECDHE-RSA-AES128-GCM-SHA256:ECDHE-ECDSA-AES256-GCM-SHA384:ECDHE-RSA-AES256-GCM-SHA384:ECDHE-ECDSA-CHACHA20-POLY1305:ECDHE-RSA-CHACHA20-POLY1305:DHE-RSA-AES128-GCM-SHA256:DHE-RSA-AES256-GCM-SHA384"; + ssl_ecdh_curve secp384r1; # ECDH 곡선 설정 (nginx >= 1.1.0) + + # OCSP 스테이플링 - SSL 핸드셰이크 성능 향상 + # 인증서에 OCSP URL이 없으면 자동으로 비활성화됨 (경고는 정상) + ssl_stapling on; + ssl_stapling_verify on; + ssl_trusted_certificate /etc/letsencrypt/live/domain/chain.pem; + resolver 1.1.1.1 8.8.8.8 valid=300s; # Cloudflare와 Google DNS 사용 + resolver_timeout 5s; + + # 보안 헤더 - 다양한 공격으로부터 보호 + add_header Strict-Transport-Security "max-age=63072000; includeSubDomains; preload" always; # HSTS - 다운그레이드 공격 방지 + add_header X-Frame-Options "DENY" always; # 클릭재킹 방지 + add_header X-Content-Type-Options "nosniff" always; # MIME 스니핑 방지 + add_header X-XSS-Protection "1; mode=block" always; # 레거시 XSS 보호 + add_header Referrer-Policy "strict-origin-when-cross-origin" always; # 리퍼러 정보 제어 + add_header Content-Security-Policy "default-src 'self'; script-src 'self' 'unsafe-inline' ''; style-src 'self' 'unsafe-inline'; img-src 'self' data: https:; font-src 'self' data:; connect-src 'self' wss: ws:;" always; + # XSS 방지를 위한 CSP + # 'unsafe-inline'은 범용 설정이 아니며, 보안상 위험한 설정입니다. CSP의 핵심 보호 기능을 무력화시키므로, 개발 환경이나 레거시 코드 마이그레이션 과정에서만 임시로 사용하고, 프로덕션 환경에서는 nonce, hash, 또는 외부 파일 분리 방식으로 대체해야 합니다. + + # 클라이언트가 업로드할 수 있는 전체 요청 본문(body) 의 최대 허용 크기 + # 요청 바디(파일, 폼 데이터 등)가 이 값을 초과하면 Nginx는 즉시 413 Request Entity Too Large 에러를 반환 + # 업로드 제한선. + client_max_body_size 100M; # 최대 업로드 크기 제한 (애플리케이션에 맞게 조정) + + # 파일 캐시 - I/O 성능 향상 + open_file_cache max=1000 inactive=20s; # 최대 1000개 파일 캐시, 20초 비활성 시 제거 + open_file_cache_valid 30s; # 캐시 유효성 검사 주기 + open_file_cache_min_uses 2; # 최소 2회 사용 시 캐시 + open_file_cache_errors on; # 파일 오류도 캐시 + + # 로깅 설정 - 버퍼링으로 I/O 감소 + access_log /log/nginx/domain.com.gunicorn_access.log main buffer=32k flush=5s; + error_log /log/nginx/domain.com.gunicorn_error.log warn; + + # frontend에 오류 페이지 정의가 되어 있는 경우 사용 가능 + # # 커스텀 오류 페이지 - 더 나은 사용자 경험 및 정보 노출 방지 + # error_page 404 /404.html; + # error_page 500 502 503 504 /50x.html; + + # location = /404.html { + # internal; # 내부 리다이렉트만 허용 + # root /www/error_pages; + # } + + # location = /50x.html { + # internal; # 내부 리다이렉트만 허용 + # root /www/error_pages; + # } + + # Fastapi 미디어 파일 - 사용자 업로드 파일 + location /media { + autoindex off; # 디렉토리 목록 비활성화 + # gzip_static on; # 사전 압축된 .gz 파일 사용 + expires 30d; # 브라우저 캐시 30일 후 브라우저가 다시 요청할 때 재검증 + alias /www/webroot/media; # Fastapi 프로젝트의 미디어 파일 경로 + + # 정적 파일 캐싱 - 브라우저 캐시 최적화 + add_header Cache-Control "public, immutable"; + access_log off; # 액세스 로그 비활성화로 성능 향상 + } + + # Fastapi 정적 파일 - CSS, JS, 이미지 등 + location /static { + autoindex off; # 디렉토리 목록 비활성화 + # gzip_static on; # 사전 압축된 .gz 파일 사용 압축된 파일이 없다면 설정 무의미 + expires 30d; # 브라우저 캐시 30일 후 브라우저가 다시 요청할 때 재검증 + alias /www/webroot/static; # Fastapi 프로젝트의 정적 파일 경로 + + # 정적 파일 캐싱 - 브라우저 캐시 최적화 + add_header Cache-Control "public, immutable"; + access_log off; # 액세스 로그 비활성화로 성능 향상 + } + + # 메인 애플리케이션 - 백엔드로 프록시 + location / { + autoindex off; # 디렉토리 목록 비활성화 + + # 속도 제한 - DDoS 및 무차별 대입 공격 방지 + # (nginx.conf의 http 블록에서 limit_req_zone과 limit_conn_zone 정의 필요) + limit_req zone=general burst=20 nodelay; # 초당 요청 제한 + limit_conn addr 10; # IP당 동시 연결 제한 + + # HTTP 메서드 제한 - HTTP 동사 변조 공격 방지 + limit_except GET POST HEAD OPTIONS { + deny all; + } + + # 백엔드 애플리케이션으로 프록시 + proxy_pass http://appname:serviceport; + + # WebSocket 지원 - 실시간 통신 애플리케이션에 필수 + proxy_http_version 1.1; + proxy_set_header Upgrade $http_upgrade; + proxy_set_header Connection $connection_upgrade; # nginx.conf에서 $connection_upgrade 맵 정의 필요 + + # 프록시 헤더 - 클라이언트 정보 전달 + proxy_set_header Host $host; + proxy_set_header X-Real-IP $remote_addr; + proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for; + proxy_set_header X-Forwarded-Proto $scheme; + proxy_set_header X-Forwarded-Host $host; + proxy_set_header X-Forwarded-Port $server_port; + + # 타임아웃 설정 - 애플리케이션에 맞게 조정 + proxy_connect_timeout 60s; + proxy_send_timeout 60s; + proxy_read_timeout 60s; + + # 버퍼 설정 - 대화형 애플리케이션에 최적화 - Websocket 사용시 설정 + # proxy_buffering off; # 즉시 응답 전달 + # proxy_request_buffering off; # 즉시 요청 전달 + + # 버퍼링 활성화 (기본값) - 기본 fastapi 사용시 설정 + proxy_buffering on; + proxy_request_buffering on; + + # 버퍼 크기 설정 - 기본 fastapi 사용시 설정 + proxy_buffer_size 4k; + proxy_buffers 8 4k; + proxy_busy_buffers_size 8k; + + proxy_set_header Accept-Encoding gzip; + } + + # Let's Encrypt 도메인 검증 프로그램 허용 (HTTPS에서도 필요시) + location ^~ /.well-known/acme-challenge/ { + allow all; + root /www/certbot; + try_files $uri =404; # 디렉토리 순회 공격 방지 + } + + # 정적 리소스 캐싱 - 이미지, 폰트, CSS, JS 등 + # 브라우저 캐시로 로드 시간 단축 및 서버 부하 감소 + location ~* \.(jpg|jpeg|png|gif|ico|css|js|woff|woff2|ttf|svg)$ { + expires 1y; # 1년 캐시 + add_header Cache-Control "public, immutable"; + access_log off; # 액세스 로그 비활성화로 성능 향상 + } + + # 닷 파일 차단 - .htaccess, .htpasswd, .svn, .git, .env 등 + # 민감한 설정 파일 노출 방지 + location ~ /\. { + deny all; + access_log off; # 차단된 시도 로그 비활성화 + log_not_found off; + } + + # 민감한 파일 확장자 차단 - 로그, 인증서, 스크립트, SQL 등 + # 보안을 위해 직접 접근 차단 + location ~* \.(log|binary|pem|enc|crt|conf|cnf|sql|sh|key|yml|lock)$ { + deny all; + access_log off; # 차단된 시도 로그 비활성화 + log_not_found off; + } + + # 민감한 설정 파일 차단 - composer, package.json, phpunit 등 + # 프로젝트 메타데이터 및 설정 파일 노출 방지 + location ~* (composer\.json|composer\.lock|composer\.phar|contributing\.md|license\.txt|readme\.rst|readme\.md|readme\.txt|copyright|artisan|gulpfile\.js|package\.json|phpunit\.xml|access_log|error_log|gruntfile\.js)$ { + deny all; + access_log off; # 차단된 시도 로그 비활성화 + log_not_found off; + } + + # 파비콘 - 로그 노이즈 제거 + location = /favicon.ico { + log_not_found off; + access_log off; + } + + # robots.txt - 검색 엔진 크롤러 제어 + location = /robots.txt { + log_not_found off; + access_log off; + allow all; + } +} diff --git a/docker/gunicorn/Dockerfile b/docker/gunicorn/Dockerfile new file mode 100644 index 0000000..cae67f5 --- /dev/null +++ b/docker/gunicorn/Dockerfile @@ -0,0 +1,73 @@ +FROM ubuntu:latest + +RUN apt-get update +RUN DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends apt-utils + +ENV TZ=Asia/Seoul + +RUN apt-get install -yq tzdata +RUN ln -snf /usr/share/zoneinfo/$TZ /etc/localtime && echo $TZ > /etc/timezone + +# curl/wget/git/gnupg2/lsb-release/lz4/zstd +RUN apt-get install -y curl wget git tar gnupg2 lsb-release lz4 zstd +# vim +RUN apt-get install -y vim + +# Python +RUN apt-get install -y build-essential zlib1g-dev libncurses5-dev libgdbm-dev libnss3-dev libssl-dev libreadline-dev libffi-dev libsqlite3-dev +RUN cd /usr/src ; wget https://www.python.org/ftp/python/3.14.0/Python-3.14.0.tar.xz ; tar -xf Python-3.14.0.tar.xz ; cd Python-3.14.0 ; ./configure ; make altinstall +RUN rm -rf /usr/src/Python-3.14.0 /usr/src/Python-3.14.0.tar.xz + +# replace python version to have 3.14 as default +RUN rm -f /usr/bin/python +RUN rm -f /usr/bin/python3 +RUN ln -s /usr/local/bin/python3.14 /usr/bin/python +RUN ln -s /usr/local/bin/python3.14 /usr/bin/python3 +RUN ln -s /usr/local/bin/python3.14 /usr/local/bin/python +RUN ln -s /usr/local/bin/python3.14 /usr/local/bin/python3 + +ENV PYTHONUNBUFFERED=1 + +# create links to pip3.14 +RUN ln -s /usr/local/bin/pip3.14 /usr/bin/pip +RUN ln -s /usr/local/bin/pip3.14 /usr/bin/pip3 +RUN ln -s /usr/local/bin/pip3.14 /usr/local/bin/pip +RUN ln -s /usr/local/bin/pip3.14 /usr/local/bin/pip3 + +# update apt-get +RUN apt-get update && apt-get -y upgrade +RUN pip install --upgrade pip +RUN pip3 install --upgrade pip + +RUN apt-get install -y python3-dev libmysqlclient-dev pkg-config + +RUN pip3 install wheel + +# SQLAlchemy +RUN pip3 install sqlalchemy alembic pydantic + +# postgresql 동기 / 비동기 +RUN pip3 install psycopg2-binary asyncpg + +# mysql 동기 / 비동기 +RUN pip3 install mysqlclient asyncmy + +# mysql 백업 +RUN curl -O https://repo.percona.com/apt/percona-release_latest.generic_all.deb +RUN apt-get install -y ./percona-release_latest.generic_all.deb +RUN rm -f percona-release_latest.generic_all.deb +RUN apt-get update +RUN percona-release enable pxb-84-lts +RUN apt-get install -y percona-xtrabackup-84 + +# postgresql 백업 +RUN apt-get -y install pgbackrest + +# gunicorn & uvicorn +RUN pip3 install gunicorn uvicorn[standard] + +# pip3 package +RUN pip3 install fastapi uv + +RUN apt-get clean && rm -rf /var/lib/apt/lists/* /tmp/* /var/tmp/* +RUN update-ca-certificates diff --git a/docker/nginx/Dockerfile b/docker/nginx/Dockerfile new file mode 100644 index 0000000..3360c3a --- /dev/null +++ b/docker/nginx/Dockerfile @@ -0,0 +1,51 @@ +FROM nginx:latest + +# ======================================== +# 1. APT 업데이트 +# ======================================== +RUN apt-get update + +# ======================================== +# 2. APT 기본 도구 설치 (경고 제거용) +# ======================================== +RUN DEBIAN_FRONTEND=noninteractive apt-get install -y --no-install-recommends apt-utils + +# ======================================== +# 3. 타임존 설정 (Asia/Seoul) +# ======================================== +ENV TZ=Asia/Seoul +RUN apt-get install -yq tzdata +RUN ln -snf /usr/share/zoneinfo/$TZ /etc/localtime && echo $TZ > /etc/timezone + +# ======================================== +# 4. 필요한 패키지 설치 +# ======================================== +RUN apt-get install -y sendmail wget gnupg + +# ======================================== +# 7. Cron 및 Certbot 설치 (SSL 인증서 자동 갱신) +# ======================================== +RUN apt-get install -y cron certbot python3-certbot-nginx + +# ======================================== +# 8. CA 인증서 설치 및 업데이트 +# ======================================== +RUN apt-get update && apt-get install -y ca-certificates +RUN update-ca-certificates +RUN chmod 644 /etc/ssl/certs/ca-certificates.crt + +# ======================================== +# 9. APT 캐시 정리 +# ======================================== +RUN apt-get autoremove -y && apt-get clean +RUN rm -rf /var/lib/apt/lists/* + +# ======================================== +# 10. Certbot 자동 갱신 Cron 작업 등록 +# ======================================== +RUN crontab -l | { cat; echo "0 5 * * 1 certbot renew --quiet --deploy-hook \"nginx -t && service nginx reload\" >> /log/nginx/crontab_$(date +\%Y\%m\%d).log 2>&1"; } | crontab - + +# ======================================== +# 11. Nginx 시작 스크립트에 Cron 추가 +# ======================================== +RUN sed -i'' -r -e "/set/i\cron" docker-entrypoint.sh diff --git a/log/nginx/.gitkeep b/log/nginx/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/log/uvicorn/celery/.gitkeep b/log/uvicorn/celery/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/log/uvicorn/celerybeat/.gitkeep b/log/uvicorn/celerybeat/.gitkeep new file mode 100644 index 0000000..e69de29 diff --git a/script/crontab_gunicorn_set.sh b/script/crontab_gunicorn_set.sh new file mode 100644 index 0000000..75abad4 --- /dev/null +++ b/script/crontab_gunicorn_set.sh @@ -0,0 +1,3 @@ +#!/bin/bash + +echo "0 6 * * 1 root docker restart nginx-gunicorn-webserver" >> /etc/crontab diff --git a/script/letsencrypt.sh b/script/letsencrypt.sh new file mode 100644 index 0000000..cccfcb6 --- /dev/null +++ b/script/letsencrypt.sh @@ -0,0 +1,91 @@ +#!/bin/bash + +my_array=() +delimiter="-d" +domain_string="" + +apt-get update && apt-get install -y sendmail wget vim cron certbot python3-certbot-nginx ca-certificates +while : +do + echo -n "Enter the service webroot_folder >" + read webroot_folder + echo "Entered service webroot_folder: $webroot_folder" + if [[ "$webroot_folder" != "" ]]; then + break + fi +done + +while : +do + echo -n "To add a subdomain, type something like 'aaa.com www.aaa.com sub.aaa.com', but all domains refer to the same web root" + echo -n "A domain in aaa.com format must be entered first." + echo -n "Enter the service domain >" + read domain + echo "Entered service domain: $domain" + if [[ "$domain" != "" ]]; then + break + fi +done + +IFS=' ' read -ra my_array <<< "$domain" + +while : +do + echo -n "Enter the user e-mail >" + read mail + echo "Entered user e-mail: $mail" + if [[ "$mail" != "" ]]; then + break + fi +done + +for element in "${my_array[@]}"; do + domain_string+=" $delimiter $element" +done + +# Remove leading space +# domain_string="${domain_string# }" + +# for element in "${my_array[@]}"; do +if ! test -f /ssl/${my_array[0]}/dhparam.pem ; then + if ! test -f /etc/ssl/certs/${my_array[0]}/dhparam.pem ; then + echo "try to create ssl key using openssl " + if ! test -d /etc/ssl/certs/${my_array[0]}/ ; then + echo "create "${my_array[0]}" folder: /etc/ssl/certs/"${my_array[0]}"/" + mkdir -p /etc/ssl/certs/${my_array[0]}/ + fi + openssl dhparam -out /etc/ssl/certs/${my_array[0]}/dhparam.pem 4096 + if ! test -d /ssl/${my_array[0]}/ ; then + echo "create "${my_array[0]}" folder: /ssl/"${my_array[0]}"/" + mkdir -p /ssl/${my_array[0]}/ + fi + cp /etc/ssl/certs/${my_array[0]}/dhparam.pem /ssl/${my_array[0]}/ -r + # else + # echo "copy ssl folder by already maden" + # cp /ssl/certs/$domain/dhparam.pem /etc/ssl/certs/dhparam.pem -r + fi +else + if ! test -d /etc/ssl/certs/${my_array[0]}/ ; then + echo "create "${my_array[0]}" folder: /etc/ssl/certs/"${my_array[0]}"/" + mkdir -p /etc/ssl/certs/${my_array[0]}/ + fi + cp /ssl/${my_array[0]}/dhparam.pem /etc/ssl/certs/${my_array[0]}/ -r +fi +# done + +#if ! test -d /etc/letsencrypt/live/test.com ; +if ! test -d /etc/letsencrypt/${my_array[0]}/letsencrypt ; then + echo "try to create authentication key using certbot " + certbot certonly --non-interactive --agree-tos --email $mail --webroot -w /www/$webroot_folder$domain_string + echo "certbot certonly --non-interactive --agree-tos --email "$mail" --webroot -w /www/"$webroot_folder$domain_string + # if ! test -d /ssl/letsencrypt/$domain/ ; then + # echo "create domain folder: /ssl/letsencrypt/"$domain"/" + # mkdir -p /ssl/letsencrypt/$domain/ + # fi + #cp /etc/letsencrypt/ /ssl/letsencrypt/$domain/ -r +# else +# echo "copy letsencrypt folder by already maden" +# cp /ssl/letsencrypt/$domain/ /etc/letsencrypt/ -r +fi + +cat <(crontab -l) <(echo '0 5 * * 1 certbot renew --quiet --deploy-hook "service nginx restart" > /log/nginx/crontab_renew.log 2>&1') | crontab - \ No newline at end of file diff --git a/script/loglotate/uvicorn/celery/uvicorn-celery b/script/loglotate/uvicorn/celery/uvicorn-celery new file mode 100644 index 0000000..0713d77 --- /dev/null +++ b/script/loglotate/uvicorn/celery/uvicorn-celery @@ -0,0 +1,14 @@ +# Uvicorn Celery Worker 로그 로테이션 설정 +# - Docker 컨테이너 환경에서 무중단 운영을 위해 copytruncate 방식 사용 +# - copytruncate: 로그 파일을 복사 후 원본을 비우는 방식 (서비스 재시작 불필요) +# - 로테이션 순간 극소량의 로그가 누락될 수 있으나 서비스는 중단되지 않음 +/log/uvicorn/celery/*.log { + daily + size 100M + rotate 30 + missingok + notifempty + compress + delaycompress + copytruncate +} diff --git a/script/loglotate/uvicorn/celerybeat/uvicorn-celerybeat b/script/loglotate/uvicorn/celerybeat/uvicorn-celerybeat new file mode 100644 index 0000000..53c0f33 --- /dev/null +++ b/script/loglotate/uvicorn/celerybeat/uvicorn-celerybeat @@ -0,0 +1,13 @@ +# Uvicorn Celery Beat 로그 로테이션 설정 +# - Docker 컨테이너 환경에서 무중단 운영을 위해 copytruncate 방식 사용 +# - copytruncate: 로그 파일을 복사 후 원본을 비우는 방식 (서비스 재시작 불필요) +# - 로테이션 순간 극소량의 로그가 누락될 수 있으나 서비스는 중단되지 않음 +/log/uvicorn/celerybeat/*.log { + daily + rotate 30 + missingok + notifempty + compress + delaycompress + copytruncate +} diff --git a/script/loglotate/uvicorn/uvicorn b/script/loglotate/uvicorn/uvicorn new file mode 100644 index 0000000..1275088 --- /dev/null +++ b/script/loglotate/uvicorn/uvicorn @@ -0,0 +1,14 @@ +# Uvicorn 로그 로테이션 설정 +# - Docker 컨테이너 환경에서 무중단 운영을 위해 copytruncate 방식 사용 +# - copytruncate: 로그 파일을 복사 후 원본을 비우는 방식 (서비스 재시작 불필요) +# - 로테이션 순간 극소량의 로그가 누락될 수 있으나 서비스는 중단되지 않음 +/log/uvicorn/*.log { + daily + size 100M + rotate 30 + missingok + notifempty + compress + delaycompress + copytruncate +} diff --git a/script/nginx/nginx b/script/nginx/nginx new file mode 100644 index 0000000..9913439 --- /dev/null +++ b/script/nginx/nginx @@ -0,0 +1,21 @@ +# Nginx 로그 로테이션 설정 +# - Docker 컨테이너 환경에서 무중단 운영을 위해 copytruncate 방식 사용 +# - copytruncate: 로그 파일을 복사 후 원본을 비우는 방식 (서비스 재시작 불필요) +# - 로테이션 순간 극소량의 로그가 누락될 수 있으나 서비스는 중단되지 않음 +/log/nginx/*.log { + daily + size 100M + rotate 30 + missingok + notifempty + compress + delaycompress + create 0640 nginx nginx + sharedscripts + postrotate + # Nginx에 USR1 signal 전송 + if [ -f /var/run/nginx.pid ]; then + kill -USR1 `cat /var/run/nginx.pid` + fi + endscript +} \ No newline at end of file