[Server] Fix README on usage and installation directions

This commit is contained in:
Eric Kilmer
2022-10-12 17:59:30 -04:00
parent 85d5712fa1
commit a903ffa8f6
2 changed files with 12 additions and 5 deletions
+12 -1
View File
@@ -1,8 +1,19 @@
# Manticore Server
Manticore Server is a gRPC service that acts as a wrapper around [Manticore](https://github.com/trailofbits/manticore), to support projects like the [Manticore User Interface (MUI)](https://github.com/trailofbits/ManticoreUI). Manticore Server is designed to allow developers to more easily create tools around Manticore that aren't in Python or to allow for Manticore to be run and managed in the cloud/remotely.
❗NOTE❗: The server is not published or packaged anywhere and is intended to be installed from source in a clean Python virtual environment. The server is only tested for compatibility with the version of Manticore living in the parent directory; this version of Manticore is installed when installing the server.
# Usage
The Manticore Server can be run via `python3 manticore_server.py` on port `50010`.
Create a new Python virtual environment:
```bash
python3 -m venv venv
source venv/bin/activate
```
Install the server with `pip install .`. This will install Manticore from the parent directory.
The Manticore Server can be run via `manticore_server`, and it will run on port `50010`.
Your Manticore Server client will require the relevant gRPC client code. You can find out how to generate gRPC client code in your desired language from [the gRPC website](https://grpc.io/docs/languages/).
@@ -550,7 +550,3 @@ def main():
stop_event.wait()
server.stop(None)
logger.info("shutdown gracefully!")
if __name__ == "__main__":
main()