-
Notifications
You must be signed in to change notification settings - Fork 670
docs: enterprise docker readme #3764
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Open
Mohamed-Hacene
wants to merge
3
commits into
main
Choose a base branch
from
documentation/enterprise-docker-readme
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
+148
−0
Open
Changes from 2 commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,113 @@ | ||
| # Installing CISO Assistant Enterprise with Docker | ||
|
|
||
| ## Prerequisites | ||
|
|
||
| - Docker and Docker Compose installed | ||
| - Python 3.10+ | ||
| - Access to the Enterprise Docker images (provided by Intuitem) | ||
|
|
||
| ## Installation in 5 steps | ||
|
|
||
| ### 1. Clone the repository | ||
|
|
||
| ```bash | ||
| git clone https://github.com/intuitem/ciso-assistant-community.git | ||
| cd ciso-assistant-community | ||
| ``` | ||
|
|
||
| ### 2. Install the configuration dependencies | ||
|
|
||
| ```bash | ||
| cd enterprise/config | ||
| pip install -r requirements.txt | ||
| ``` | ||
|
|
||
| ### 3. Generate the Docker configuration | ||
|
|
||
| ```bash | ||
| python make_config.py | ||
| ``` | ||
|
|
||
| The script guides you step by step with simple questions: | ||
|
|
||
| - **Deployment**: local or on a remote server? | ||
| - **HTTPS certificate**: automatic Let's Encrypt, your own certificate, or self-signed (default) | ||
| - **Address and port**: your domain name (e.g. `grc.company.com`) and access port (default `8443`) | ||
| - **Database**: SQLite (simple, ideal to get started) or PostgreSQL (recommended for production) | ||
| - **Reverse proxy**: Caddy (default, simpler) or Traefik | ||
| - **Email**: SMTP configuration for sending notifications (optional) | ||
| - **License**: number of seats and expiration date | ||
| - **Debug**: enable or disable debug mode | ||
|
|
||
| Once complete, a `docker-compose.yml` file is automatically generated. | ||
|
|
||
| ### 4. Start the application | ||
|
|
||
| #### First time only | ||
|
|
||
| The initialization script handles everything (pull, start, and admin account creation): | ||
|
|
||
| ```bash | ||
| ./docker-compose.sh | ||
| ``` | ||
|
|
||
| > This script only works on a fresh install (no existing `db/` folder). For all subsequent operations, use the manual commands below. | ||
|
|
||
| #### Manual commands (start, stop, restart) | ||
|
|
||
| ```bash | ||
| docker compose pull # download the latest images | ||
| docker compose up -d # start all services | ||
| docker compose down # stop all services | ||
| docker compose up -d # restart | ||
| ``` | ||
|
|
||
| To create an admin account manually: | ||
|
|
||
| ```bash | ||
| docker compose exec -it backend poetry run python manage.py createsuperuser | ||
| ``` | ||
|
|
||
| ### 5. Connect | ||
|
|
||
| Open your browser at: | ||
|
|
||
| ``` | ||
| https://your-domain:8443 | ||
| ``` | ||
|
|
||
| Replace `your-domain` with the domain name you entered in step 3. | ||
|
|
||
| --- | ||
|
|
||
| ## Stopping the application | ||
|
|
||
| ```bash | ||
| cd enterprise/config | ||
| docker compose down | ||
| ``` | ||
|
|
||
| This stops and removes all containers. Your data in `db/` is preserved. | ||
|
|
||
| --- | ||
|
|
||
| ## Updating | ||
|
|
||
| ```bash | ||
| cd enterprise/config | ||
| docker compose pull | ||
| docker compose up -d | ||
| ``` | ||
|
|
||
| Database migrations are applied automatically on restart. | ||
|
|
||
| > Never delete the `db/` folder — it contains your database and uploaded files. | ||
|
|
||
| --- | ||
|
|
||
| ## Troubleshooting | ||
|
|
||
| | Symptom | What to do | | ||
| | ----------------------- | ----------------------------------------------------------------------------------- | | ||
| | Application won't start | Run `docker compose logs backend` to check errors | | ||
| | License error | Check `LICENSE_SEATS` and `LICENSE_EXPIRATION` values in `docker-compose.yml` | | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Uh oh!
There was an error while loading. Please reload this page.