Add instructions for upgrading Copilot
Taylor committed
Feb 3, 2024 at 10:37 UTC
581c8a4ad9606b1c48b3699bedf5bbe857c6bc12
1 file changed
+18
README.md
+18
@@ -18,6 +18,7 @@ SOCFortress CoPilot
18
19
- [Getting Started](#getting-started)
20
- [Running Copilot](#runnning-copilot)
21
+ - [Upgrading Copilot](#upgrading-copilot)
22
- [Connectors](#connectors)
23
- [Help](#help)
24
- [License](#license)
@@ -79,6 +80,23 @@ By default, an `admin` account is created. The password is printed in stdout the
80
81
🚀 **YouTube Tutorial:** [SOCFortress CoPilot - Getting Started](https://youtu.be/seITDGXAiJw)
82
83
+### Upgrading Copilot
84
+
85
+🛠 You will likely want to upgrade often as we are frequently pushing new changes.
86
+
87
+To upgrade Copilot, you will need to stop the running container, pull the latest docker image, and start the container again.
88
+
89
+```bash
90
+# Stop the running container. Make sure you are in the CoPilot directory
91
+docker compose down
92
+
93
+# Pull the latest docker image
94
+docker pull ghcr.io/socfortress/copilot:latest
95
+
96
+# Start the container again
97
+docker compose up -d
98
+```
99
+
100
## Connectors
101
102
Copilot is designed to be a single pane of glass for your security operations. Think of it as a hub for all your security tools. Copilot Connectors are the glue that binds your security tools to Copilot. We take advantage of the APIs and webhooks provided by your security tools to provide a seamless integration.