Browse Source

Add doc for running the remote data service

James Barnett 1 year ago
parent
commit
8acc6daf9b
No account linked to committer's email address
1 changed files with 27 additions and 0 deletions
  1. 27
    0
      documentation/api/v1/remote_data_service_help.md

+ 27
- 0
documentation/api/v1/remote_data_service_help.md View File

@@ -0,0 +1,27 @@
1
+# Metasploit Remote Data Service
2
+
3
+The Metasploit Remote Data service is a tool that allows you to host a web service to interact
4
+with Metasploit's various data models through a REST API.
5
+
6
+### Requirements.
7
+You can find more information on setting that up on the 
8
+[Metasploit help page](https://metasploit.help.rapid7.com/docs/managing-the-database).
9
+
10
+### Starting Up
11
+To start up the web server, navigate to the root directory of metasploit-framework and run the
12
+following command: `./msfdb_ws`
13
+
14
+Command line options:
15
+
16
+ - `-i`,`--interface` Specify the interface for the web service to listen on. Default: 0.0.0.0
17
+ - `-p`,`--port` Specify the port for the web service to listen on. Default: 8080
18
+ - `-s`,`--ssl` Enable SSL on the web server.
19
+ - `-c`,`--cert /path/to/cert_file` Path to SSL certificate file. Required if `-s` is set.
20
+ - `-k`,`--key /path/to/key_file` Path to SSL Key file.
21
+ - `-h`,`--help` Display the help information.
22
+ 
23
+### Accessing the API
24
+The API can be accessed by utilizing your preferred HTTP client of choice. You can find more
25
+information on the data models and various endpoints by connecting to the following URL:
26
+
27
+http://\<interface\>:\<port\>/api/v1/api-docs

Loading…
Cancel
Save