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

Documentation: Updated instructions for setting up msfdb #18843

Closed
wants to merge 2 commits into from

Conversation

jlownie
Copy link
Contributor

@jlownie jlownie commented Feb 16, 2024

I am a new user of Metasploit. I was working through a tutorial and I needed to know how to setup msfdb, so I looked at the documentation. I ran into the following problems:

  1. I didn't know how to connect to the database
  2. I didn't know how to start the Web Service setup process

This commit and PR adds that information to the documentation.

Added some missing information
Documentation: Updated instructions for setting up msfdb
@jlownie
Copy link
Contributor Author

jlownie commented Feb 16, 2024

After I submitted the PR I found other documentation that indicates that the Web Service is supposed to be setup by default when you run the init command. This didn't happen in my case, I don't know if that is a bug or not. I will await guidance on how to proceed with this.

@adfoster-r7
Copy link
Contributor

Thanks for the pull request!

I found other documentation that indicates that the Web Service is supposed to be setup by default when you run the init command

We no longer enable it by default, and plan to remove it in the future as we're not sure users are using the functionality. No need to change the documentation here though, I think the current changes are good to go 👍

@adfoster-r7 adfoster-r7 added the needs-unique-branch The pull request must not be from the master branch label Feb 16, 2024
Copy link

Thanks for your pull request! We require for all contributed code to come from a from a unique branch in your repository before it can be merged.

Please create a new branch in your fork of framework and resubmit this from that branch.

If you are using Git on the command line that may look like:

# Checkout the master branch
git checkout master

# Create a new branch for your feature
git checkout -b <BRANCH_NAME>

# Add your new files
git add modules/my-cool-new-module

# Commit your changes with a relevant message
git commit

# Push your changes to GitHub
git push origin <BRANCH_NAME>

# Now browse to the following URL and create your pull request!
# - https://github.com/rapid7/metasploit-framework/pulls

This helps protect the process, ensure users are aware of commits on the branch being considered for merge, allows for a location for more commits to be offered without mingling with other contributor changes and allows contributors to make progress while a PR is still being reviewed.

Please do resubmit from a unique branch, we greatly value your contribution! 🎉

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
needs-unique-branch The pull request must not be from the master branch
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

2 participants