Skip to content

Commit

Permalink
Update README with instructions to install and run the server
Browse files Browse the repository at this point in the history
  • Loading branch information
anchal00 committed Aug 20, 2024
1 parent 2832798 commit 3922e82
Show file tree
Hide file tree
Showing 3 changed files with 33 additions and 2 deletions.
4 changes: 4 additions & 0 deletions INIT
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
#!/bin/bash

sudo $(which optimus) "$@"

29 changes: 29 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,13 @@
### Optimus 🤖

#### Installation:

1. Clone the repository and cd into it
2. Run `pip install . `


##### How to run ?

```
usage: Optimus [-h] [-r] [-p PORT] [-t THREADS]
Expand All @@ -11,3 +19,24 @@ optional arguments:
-p PORT Port to run the server on (defaults to 53)
-t THREADS Number of worker threads to spin up for handling requests (defaults to 100)
```

#### Note:
You may not be able to run Optimus on Port 53 as your OS already is likely to be running it's own resolver.

To workaround this, you may

1. Either, disable your exiting resolver and run Optimus on port 53 which might also require [root privileges](#Running Optimus with Root privileges).
2. Or, Simply run the Optimus server on some other port.


##### Running Optimus with Root privileges:

There could be better ways to do this but this is the only makeshift solution that I have at this moment)

Once the existing resolver is disabled and Port 53 is freed up

1. Copy the script `INIT` to `/usr/local/bin`
2. Rename `INIT` to `optimus_server`
3. Make `optimus_server` executable using `chmod +x /usr/local/bin/optimus_server`
4. Now you can invoke Optimus using this executable from your terminal simply by running `optimus_server`

2 changes: 0 additions & 2 deletions init

This file was deleted.

0 comments on commit 3922e82

Please sign in to comment.