Skip to content
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

Update README.md to include a demo site or screenshots #15

Open
mindware opened this issue May 6, 2020 · 9 comments
Open

Update README.md to include a demo site or screenshots #15

mindware opened this issue May 6, 2020 · 9 comments

Comments

@mindware
Copy link

mindware commented May 6, 2020

Understanding the project initially is a little difficult
The README is helpful but I'm not 100% sure what the project looks like coming in for the first time.

Improving README.md with helpful content
Providing a link to a live demo site or screenshots of the system and basic capabilities would be very helpful to increase adoption and participation.

@brian-ruf
Copy link
Owner

Thank you @mindware! I haven't had much time for this recently and hope to circle back to it once I get the FedRAMP Guides (to SAP, SAR, and POA&M) drafted. I'll certainly update the readme, plus I might have some updates to push soon.

@garik-pilot
Copy link

Hi, II tried to install in docker but there are some errors when I launched bat file. Is it possible to share the steps on how to install it, please?

@brian-ruf
Copy link
Owner

brian-ruf commented May 22, 2020

@garik-pilot: A colleague created that for me, and has a quirk. I didn't realize it was still in the repo. I fixed it on my system, but haven't made it so it works on any system yet. Here's the manual fix:

First, if you are new to Docker you have to make sure it is configured for file sharing (Settings, Resources, File Sharing). Make sure to share the drive with your clone of the repo.

Then, find and delete the "$PWD" in the batch file - delete the enclosing quotes too. They are part of the problem.

Then put in the Linux-style path to your clone of the repo. My Git repos are all in D:\GitRepos, so for me, the line ended up looking like this:

docker run -p 80:8080 -v "/d/GitRepos/OSCAL-GUI/webroot":/var/www/html trafex/alpine-nginx-php7

As I mentioned in my previous comment, I hope to circle back to this work next month, with some great updates in mind. On my to-do list is to fix the Docker command so it works for everyone without modification.

@garik-pilot
Copy link

garik-pilot commented May 22, 2020 via email

@garik-pilot
Copy link

garik-pilot commented May 22, 2020 via email

@brian-ruf
Copy link
Owner

@garik-pilot - That's great!
It should be running on port 80, not 8080, and it should just be right at the root of localhost.

http://localhost

@garik-pilot
Copy link

garik-pilot commented May 22, 2020 via email

@brian-ruf
Copy link
Owner

@garik-pilot, I think you can just change the "80" in the command line to whatever port you can use.
In other words, it might be something like this:

docker run -p 8888:8080 -v "/d/GitRepos/OSCAL-GUI/webroot":/var/www/html trafex/alpine-nginx-php7

As for XSLT, I'm still somewhat new to it myself and have benefited from working with an expert on the NIST OSCAL team. I've dabbled a little, plus had him get me started with a few transforms. There is some early work HERE, but it likely needs some tweaking to work with the latest syntax.

One goal I have for the GUI is to have a folder with XSLT files in it. Anytime I add another file (with the right metadata), the GUI will include it in the menu item, and process the appropriate OSCAL files with it. This feature was partially drafted when I needed to stop working on the GUI.

NIST has published a draft XSLT for resolving profiles. They are working out a few minor glitches, but I plan to adopt that in the GUI for profile resolution using the above modular XSLT capability.

As for tutorials, I tend to do a search and try a few to see which is working best for me.
Here are a few I've looked at in the past:
https://www.w3schools.com/xml/xml_xslt.asp

Finally, out of respect for the person who opened this issue about updating the README, can you open a second issue with any more questions, so he doesn't continue to get notifications of our conversation, or look for me on Gitter.

@garik-pilot
Copy link

garik-pilot commented May 22, 2020 via email

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

3 participants