diff --git a/README.md b/README.md index e18fce1..803579f 100644 --- a/README.md +++ b/README.md @@ -6,31 +6,30 @@ by Sublime Security Overview --------- -An open, adaptable email security platform for writing, running, and sharing custom detection and response rules to block phishing attacks, hunt for threats, and more. +A free and open platform for detecting and preventing email attacks like BEC, malware, and credential phishing. Gain visibility and control, hunt for advanced threats, and collaborate with the community. -Why? ----------- -Traditional email security is a one-size-fits-all black box. +Sublime uses Message Query Language (MQL), a domain-specific language purpose-built for describing behavior in email. MQL is email provider agnostic, enabling defenders to write, run, and share Detections-as-Code. -The Sublime Platform **gives defenders control over their email environment** and uses an intuitive, interoperable, purpose-built domain-specific language (DSL). +Learn more about MQL: [Introduction to Message Query Language](https://sublime.security/blog/introduction-to-message-query-language-mql) Setup ---------- ```console -curl -sL https://sublime.security/install.sh | sh +curl -sL https://raw.githubusercontent.com/sublime-security/sublime-platform/main/install-and-launch.sh | sh ``` [View Docker Quickstart](https://docs.sublimesecurity.com/docs/quickstart-docker) +[View other deployment methods](https://sublime.security/start) + Detection rules ---------- -Open-source detection rules are maintained in the [sublime-rules repo](https://github.com/sublime-security/sublime-rules). - +Open-source detection rules and links to community Feeds are maintained in the [sublime-rules repo](https://github.com/sublime-security/sublime-rules). Learn more ---------- -- [Sublime overview](https://sublime.security) - [Docs](https://docs.sublimesecurity.com) -- [Message Query Language (MQL) reference](https://docs.sublimesecurity.com/docs/message-query-language) - Sublime's DSL purpose-built for email analysis +- [API](https://docs.sublimesecurity.com/reference/introduction) - [Release log](https://new.sublimesecurity.com) +- [Message Query Language (MQL)](https://docs.sublimesecurity.com/docs/message-query-language) diff --git a/docker-compose.yml b/docker-compose.yml index 1d433af..846a209 100644 --- a/docker-compose.yml +++ b/docker-compose.yml @@ -1,7 +1,7 @@ -version: '3' services: sublime_postgres: image: postgres:13.2 + command: -c 'max_connections=200' restart: unless-stopped container_name: sublime_postgres environment: @@ -82,21 +82,15 @@ services: networks: - net sublime_screenshot_service: - image: sublimesec/render-email-html:0.1 + image: sublimesec/render-email-html:0.2 restart: unless-stopped ports: - "8100:8100" environment: - - S3_ENDPOINT=http://sublimes3:8110 - - SCREENSHOT_BUCKET=email-screenshots - - AWS_REGION=us-east-1 - DISABLE_DD=true container_name: sublime_screenshot_service - env_file: sublime.env networks: - net - depends_on: - - sublime_create_buckets # Keep this name as sublimes3 because underscores don't play nice with certain endpoint validation sublimes3: container_name: sublimes3 @@ -145,6 +139,8 @@ services: WORKERS: 2 WEB_CONCURRENCY: 5 KEEP_ALIVE: 2 + WORKER_TIMEOUT: 30 + GRACEFUL_WORKER_TIMEOUT: 30 networks: net: @@ -153,3 +149,4 @@ volumes: postgres: logs: s3_data: + persistent_storage: diff --git a/install-and-launch.sh b/install-and-launch.sh index b68692c..4081f1e 100755 --- a/install-and-launch.sh +++ b/install-and-launch.sh @@ -80,7 +80,7 @@ if [ -z "$interactive" ]; then # ascii art # credit: https://patorjk.com/ # font: Cyberlarge - cat </dev/null 2>&1; then - print_error "docker compose appears to be brought down. Will not proceed to avoid relaunching." + print_error "Sublime Platform appears to have been manually shut down. Will not proceed to avoid relaunching." + print_warning "If you wish to relaunch, please refer to the documentation here:" + print_warning "https://docs.sublimesecurity.com/docs/quickstart-docker#how-to-update" exit 0 fi fi @@ -23,7 +29,7 @@ if [ -z "$(git status --porcelain)" ]; then echo "git working dir clean. Proceeding with git updates." old_ref=$(git rev-parse HEAD) - git pull + logrun git pull new_ref=$(git rev-parse HEAD) if [ "${old_ref}" != "${new_ref}" ]; then diff --git a/utils.sh b/utils.sh index 982d534..5610818 100644 --- a/utils.sh +++ b/utils.sh @@ -48,3 +48,8 @@ print_info() { print_warning() { print_color "\n$1\n" "warning" } + +logrun() { + echo >&2 "+ $*" + "$@" +}