You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+28-13Lines changed: 28 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -24,43 +24,58 @@ Ensure you have the following installed on your host or Docker environment:
24
24
25
25
## Installation & Setup
26
26
27
+
There are two primary ways to install and run AutoAR:
28
+
29
+
### Option 1: Quick Install using `go install`
30
+
Because the main executable is located in the `cmd/autoar` directory, you cannot simply run `go install github.com/h0tak88r/AutoAR@latest`. Instead, you must point directly to the binary package:
31
+
32
+
```bash
33
+
go install github.com/h0tak88r/AutoAR/cmd/autoar@latest
34
+
```
35
+
*Note: This will install the `autoar` binary to your `$GOPATH/bin` directory (typically `~/go/bin`). Make sure this directory is in your system `$PATH`.*
36
+
37
+
### Option 2: Clone and Build manually (Recommended)
27
38
1.**Clone the Repository:**
28
39
```bash
29
40
git clone https://github.com/h0tak88r/AutoAR.git
30
41
cd AutoAR
31
42
```
32
43
33
-
2.**Database Initialization:**
44
+
2.**Download Dependencies and Build:**
45
+
```bash
46
+
go mod tidy
47
+
go build -o autoar ./cmd/autoar
48
+
```
49
+
50
+
3.**Database Initialization:**
34
51
AutoAR uses PostgreSQL or SQLite (depending on your `.env`).
35
52
```bash
36
53
# Create new-results directory to store findings
37
54
mkdir -p new-results
38
55
```
39
56
40
-
3.**Configure the Environment (`.env` file):**
57
+
4.**Configure the Environment (`.env` file):**
41
58
Copy the provided `.env.example` or tailor your `.env` in the root directory. AutoAR relies strictly on these environment variables:
42
59
43
60
-**DISCORD_BOT_TOKEN**: Your Discord Bot Token (Bot must have `applications.commands` and standard message intents).
44
-
-**DISCORD_ALLOWED_GUILD_ID**: Restricts the bot exclusively to your own Guild (Server) ID.
61
+
-**DISCORD_ALLOWED_GUILD**: Restricts the bot exclusively to your own Guild (Server) Name.
45
62
-**DB_TYPE**: `postgresql` or `sqlite3`
46
63
-**DB_HOST**: Your connection URI or sqlite path.
47
64
-**OPENROUTER_API_KEY** / **GEMINI_API_KEY**: API key for your AI Analysis features.
48
65
-**AUTOAR_RESULTS_DIR**: Set to `./new-results` or `/app/new-results` if running via Docker.
49
66
-**Additional Integrations**: Shodan, Censys, VirusTotal, R2 Storage IDs as needed in `.env`.
50
67
51
-
4.**Build the Bot:**
52
-
```bash
53
-
# Download go modules
54
-
go mod tidy
55
-
56
-
# Build the main AutoAR executable
57
-
go build -o autoar ./cmd/autoar
58
-
```
59
-
60
-
5.**Run the Bot:**
68
+
5.**Run the Bot or API:**
61
69
Run the bot natively, ensuring `.env` is loaded automatically:
0 commit comments