mirror of https://github.com/MISP/misp-docker
Finalize fork
parent
25dd423617
commit
ed3b00b52a
32
README.md
32
README.md
|
@ -17,16 +17,24 @@ Like CoolAcid's MISP docker image, this is based on some of the work from the DS
|
||||||
|
|
||||||
Additionally, this fork features the following improvements:
|
Additionally, this fork features the following improvements:
|
||||||
|
|
||||||
- ARM (Apple M1) support
|
- ARM (M1) support: move mariadb for increase compatibility
|
||||||
|
- ARM (M1) support: move to updated and cross-platform mail exim4 image
|
||||||
- Fix and improve support for cron jobs
|
- Fix and improve support for cron jobs
|
||||||
- Fix Supervisor handling of entrypoints
|
- Fix and improve support for syncservers
|
||||||
- Make schema update repeatable and completely offline
|
- Fix supervisord process control (processes are correctly terminated upon reload)
|
||||||
- Fix missing MISP modules dependencies
|
- Fix schema update by making it completely offline (no user interaction required)
|
||||||
- New Background Job system, see https://github.com/MISP/MISP/blob/2.4/docs/background-jobs-migration-guide.md
|
- Fix enforcement of permissions
|
||||||
- Automatic configuration of MISP modules (see `entrypoint_internal.sh`)
|
- Fix MISP modules loading of faup library
|
||||||
- Automatic configuration of sync servers (see `entrypoint_internal.sh`)
|
- Fix MISP modules loading of gl library
|
||||||
- Automatic configuration of organizations (see `entrypoint_internal.sh`)
|
- Add support for new background job system (see https://github.com/MISP/MISP/blob/2.4/docs/background-jobs-migration-guide.md)
|
||||||
- Autoamtic configuration of authentication keys (see `entrypoint_internal.sh`)
|
- Add support for exposing locally generated resources
|
||||||
|
- Add support for building specific MISP and MISP-modules commits
|
||||||
|
- Add automatic configuration of MISP modules (see `entrypoint_internal.sh`)
|
||||||
|
- Add automatic configuration of sync servers (see `entrypoint_internal.sh`)
|
||||||
|
- Add automatic configuration of organizations (see `entrypoint_internal.sh`)
|
||||||
|
- Add autoamtic configuration of authentication keys (see `entrypoint_internal.sh`)
|
||||||
|
- Add direct push of docker images to Docker Hub
|
||||||
|
- Consolidate docker compose files
|
||||||
|
|
||||||
As a result, this image is not for everybody and does not (and will not) fit every use case.
|
As a result, this image is not for everybody and does not (and will not) fit every use case.
|
||||||
Nevertheless the underlying spirit of this fork is to allow "repeatable deployments", and all pull requests in this direction will be merged.
|
Nevertheless the underlying spirit of this fork is to allow "repeatable deployments", and all pull requests in this direction will be merged.
|
||||||
|
@ -61,11 +69,11 @@ Pull the entire repository, you can build the images using `docker-compose build
|
||||||
Once you have the docker container up you can access the container by running `docker-compose exec misp /bin/bash`.
|
Once you have the docker container up you can access the container by running `docker-compose exec misp /bin/bash`.
|
||||||
This will provide you with a root shell. You can use `apt update` and then install any tools you wish to use.
|
This will provide you with a root shell. You can use `apt update` and then install any tools you wish to use.
|
||||||
Finally, copy any changes you make outside of the container for commiting to your branch.
|
Finally, copy any changes you make outside of the container for commiting to your branch.
|
||||||
`git diff -- [dir with changes]` could be used to reduce the number of changes in a patch file, however, becareful when using the `git diff` command.
|
`git diff -- [dir with changes]` could be used to reduce the number of changes in a patch file, however, be careful when using the `git diff` command.
|
||||||
|
|
||||||
### Updating
|
### Updating
|
||||||
|
|
||||||
Updating the images should be as simple as `docker-compose pull` which, unless changed in the `docker-compose.yml` file will pull the latest built images.
|
Updating the images should be as simple as `docker-compose pull` which, unless changed in the `docker-compose.yml` file, will pull the latest built images.
|
||||||
|
|
||||||
### Production
|
### Production
|
||||||
- It is recommended to specify which build you want to be running, and modify that version number when you would like to upgrade
|
- It is recommended to specify which build you want to be running, and modify that version number when you would like to upgrade
|
||||||
|
@ -102,7 +110,7 @@ If you are interested in building the project from scratch - `git clone` or down
|
||||||
|
|
||||||
### Configuration
|
### Configuration
|
||||||
|
|
||||||
The `docker-compose.yml` file further allows the following configuration settings:
|
The `docker-compose.yml` file allows further configuration settings:
|
||||||
|
|
||||||
```
|
```
|
||||||
"MYSQL_HOST=db"
|
"MYSQL_HOST=db"
|
||||||
|
|
|
@ -49,7 +49,6 @@ services:
|
||||||
- "./ssl/:/etc/nginx/certs/"
|
- "./ssl/:/etc/nginx/certs/"
|
||||||
- "./gnupg/:/var/www/MISP/.gnupg/"
|
- "./gnupg/:/var/www/MISP/.gnupg/"
|
||||||
- "${PUBLIC_MOUNT_POINT}:/mnt/public/"
|
- "${PUBLIC_MOUNT_POINT}:/mnt/public/"
|
||||||
# - "./examples/custom-entrypoint.sh:/custom-entrypoint.sh" # Use the example custom-entrypoint.sh
|
|
||||||
environment:
|
environment:
|
||||||
- "HOSTNAME=https://localhost"
|
- "HOSTNAME=https://localhost"
|
||||||
- "REDIS_FQDN=redis"
|
- "REDIS_FQDN=redis"
|
||||||
|
|
|
@ -1,4 +0,0 @@
|
||||||
#!/bin/bash
|
|
||||||
|
|
||||||
echo Custom Entrypoint that runs just prior to nginx start
|
|
||||||
|
|
|
@ -210,10 +210,6 @@ if [[ "$DISIPV6" == true ]]; then
|
||||||
sed -i "s/listen \[\:\:\]/\#listen \[\:\:\]/" /etc/nginx/sites-enabled/misp
|
sed -i "s/listen \[\:\:\]/\#listen \[\:\:\]/" /etc/nginx/sites-enabled/misp
|
||||||
fi
|
fi
|
||||||
|
|
||||||
if [[ -x /custom-entrypoint.sh ]]; then
|
|
||||||
/custom-entrypoint.sh
|
|
||||||
fi
|
|
||||||
|
|
||||||
# delete pid file
|
# delete pid file
|
||||||
[ -f $ENTRYPOINT_PID_FILE ] && rm $ENTRYPOINT_PID_FILE
|
[ -f $ENTRYPOINT_PID_FILE ] && rm $ENTRYPOINT_PID_FILE
|
||||||
|
|
||||||
|
|
Loading…
Reference in New Issue