-
Notifications
You must be signed in to change notification settings - Fork 18
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated features, added release info and test user to the readme
Signed-off-by: Vanessa Fotso <[email protected]>
- Loading branch information
1 parent
901ef42
commit d463284
Showing
1 changed file
with
28 additions
and
1 deletion.
There are no files selected for viewing
This file contains 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 |
---|---|---|
|
@@ -11,11 +11,25 @@ Vulcan models the STIG intent form and the process of aligning security controls | |
* Model the STIG creation process between the creator (vendor) and the approver (sponsor) | ||
* Write and test InSpec code on a local system, or across SSH, AWS, and Docker targets | ||
* Easily view control status and revision history | ||
* Enable distributed authorship with multiple authors working on sets of controls and reviewing each others' work | ||
* Enable distributed authorship with multiple authors working on sets of controls and reviewing each others' work. | ||
* Enable looking up related controls (controls using the same SRG ID) in published STIGs while auhtoring or reviewing a control. | ||
* View DISA published STIG Contents. | ||
* Confidential data in the database is encrypted using symmetric encryption | ||
* Authenticate via the local server, through GitHub, and through configuring an LDAP server. | ||
* Email and Slack notification enabled | ||
|
||
## Latest Release: [v2.1.4](https://github.com/mitre/vulcan/releases/tag/v2.1.4) | ||
|
||
You can pull the Docker image for the latest release with the following command: | ||
|
||
```bash | ||
docker pull mitre/vulcan:v2.1.4 | ||
``` | ||
|
||
For more details on this release and previous ones, check the [Changelog](https://vulcan.mitre.org/CHANGELOG.html). | ||
|
||
## Deploy Vulcan | ||
|
||
[Deploying Vulcan in Production](https://vulcan.mitre.org/docs/) [<img src="public/GitHub-Mark-Light-64px.png#gh-dark-mode-only" width="20"/>](https://pages.github.com/)[<img src="public/GitHub-Mark-64px.png#gh-light-mode-only" width="20"/>](https://pages.github.com/) | ||
|
||
## Deployment Dependencies: | ||
|
@@ -36,6 +50,8 @@ For Ruby (on Ubuntu): | |
4. rbenv install | ||
5. bin/setup | ||
|
||
>> **Note**: `bin/setup` will install the JS dependencies, prepare the database and load the sample data. | ||
#### Running with Ruby | ||
|
||
Make sure you have run the setup steps at least once before following these steps! | ||
|
@@ -44,6 +60,14 @@ Make sure you have run the setup steps at least once before following these step | |
2. foreman start -f Procfile.dev | ||
3. Navigate to `http://127.0.0.1:3000` | ||
|
||
#### Test User | ||
|
||
For testing purposes in the development environment, you can use the following credentials: | ||
|
||
**Email**: <[email protected]> | ||
|
||
**Password**: 1234567ab! | ||
|
||
#### Stopping Vulcan | ||
|
||
1. Stop Vulcan by doing `ctrl + c` | ||
|
@@ -87,6 +111,9 @@ and the impact on the application's performance when deciding on the frequency. | |
|
||
>> Please refer to your hosting platform's documentation or support services for specific instructions on how to set up scheduled tasks or cron jobs. | ||
## Releasing Vulcan | ||
|
||
For detailed information about creating a release, please refer to the [release documentation](https://github.com/mitre/vulcan/wiki/Release_vulcan). | ||
|
||
### NOTICE | ||
|
||
|