ghostforge/README.md
Darryl Nixon 3cc1dfcd14 We'll deploy with docker because it's easier for
students to try, review, and give feedback.
Also, maybe it'll make actual development easier.
2023-05-23 12:07:25 -07:00

1.7 KiB

ghostforge Logo

ghostforge

ghostforge manages false identity information for privacy prudent users.

tl;dr it's a fancy DB frontend with sensible design, tailored features, and a nice UX.

InstallationUsageContributingLicense

Deployment

Installation instructions are only provided for docker-based deployment. For manual deployment, you'll need to set environment variables (see .env) for database access before running ghostforge yourself.

With docker

You'll need docker-compose installed or you can convert the contents of docker-compose.yml into docker run commands yourself. Install and run ghostforge with something like:

git clone https://github.com/darrylnixon/ghostforge.git;
cd ghostforge;
docker-compose up --detach --build;
docker exec --interactive --tty ghostforge ghostforge_adduser;

Follow the prompts to create an administrator user. Assuming you didn't change the default port, browse to http://localhost:1337/ to begin using ghostforge with your new credentials.

Contributing

If you would like to contribute to this project, feel free to submit a pull request or open an issue on GitHub.

This tool was written as part of my coursework for CSC 842 - Security Tool Development at Dakota State University. Consequently, I may choose not to maintain this tool beyond the length of the course, but have selected a license that enables open contributions in any case.

License

This project is licensed under the GPLv3 License, because it's important to give back. See the LICENSE file for details.