Skip to content
Draft
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions .github/dependabot.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
# To get started with Dependabot version updates, you'll need to specify which
# package ecosystems to update and where the package manifests are located.
# Please see the documentation for all configuration options:
# https://docs.github.com/code-security/dependabot/dependabot-version-updates/configuration-options-for-the-dependabot.yml-file

version: 2
updates:

- package-ecosystem: "github-actions"
directory: "/"
schedule:
interval: "weekly"
cooldown:
default-days: 7
14 changes: 8 additions & 6 deletions .github/workflows/docker-deploy-dev.yml
Original file line number Diff line number Diff line change
Expand Up @@ -12,23 +12,25 @@ jobs:
steps:

- name: Check out the repo
uses: actions/checkout@v2
uses: actions/checkout@v7
with:
persist-credentials: false

- name: Login to DockerHub
uses: docker/login-action@v1
uses: docker/login-action@v4.6.0
with:
username: ${{ secrets.DOCKER_USERNAME }}
password: ${{ secrets.DOCKER_PASSWORD }}

- name: Set up Docker Buildx
id: buildx
uses: docker/setup-buildx-action@v1
uses: docker/setup-buildx-action@v4.1.0
with:
driver: docker

- name: Build letsencrypt
id: build-letsencrypt
uses: docker/build-push-action@v2
- name: Build mantis
id: build-mantis
uses: docker/build-push-action@v7.1.0
with:
push: true
tags: sublimesec/nginx-letsencrypt:latest
Expand Down
49 changes: 0 additions & 49 deletions .github/workflows/docker-tests.yml

This file was deleted.

1 change: 1 addition & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
certbot.env
sublime.env
*.swp
.DS_Store
2 changes: 1 addition & 1 deletion LICENSE
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
MIT License

Copyright (c) 2021 Sublime Security
Copyright (c) 2021-2026 Sublime Security

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
Expand Down
29 changes: 18 additions & 11 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,36 +1,43 @@
<a href="https://sublimesecurity.com"><img src="https://user-images.githubusercontent.com/11003450/115128085-5805da00-9fa9-11eb-8c7a-dc8b708053ee.png" width="75px" alt="Sublime Logo" /></a>
<a href="https://sublimesecurity.com"><img src="assets/sublime-logo.png" width="75px" alt="Sublime Logo" /></a>

Sublime Platform
==========
by Sublime Security
by [Sublime Security](https://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?
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.

Learn more about MQL: [Introduction to Message Query Language](https://sublime.security/blog/introduction-to-message-query-language-mql)

Docker Usage & Caveats
----------
Traditional email security is a one-size-fits-all black box.
This Docker deployment is intended for small-medium size deployments and for testing purposes ONLY (limited to 100 active mailboxes). For the best Sublime experience, we recommend the [AWS Cloud-native deployment](https://docs.sublime.security/docs/aws-cloudformation) or [Sublime Managed Cloud](https://docs.sublime.security/docs/sublime-managed), which can support any number of mailboxes, is resilient, and has the latest features. The docker deployment allows you to gain hands on experience, but will only receive best effort support (no long term support).

[Learn more about feature restrictions for Docker Compose](https://docs.sublime.security/docs/docker-requirements-and-limitations)

The Sublime Platform **gives defenders control over their email environment** and uses an intuitive, interoperable, purpose-built domain-specific language (DSL).
The Sublime Platform Docker Compose ships as an entire setup. Modifying the docker-compose file or using our docker images within your own implementation is not supported.

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)
Binary file added assets/sublime-logo.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading