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
The simplest & fastest way to get started is to use the hosted version: https://app.maxun.dev. Maxun Cloud deals with anti-bot detection, huge proxy network with automatic proxy rotation, and CAPTCHA solving.
35
-
36
-
# Local Installation
37
-
1. Create a root folder for your project (e.g. 'maxun')
38
-
2. Create a file named `.env` in the root folder of the project
39
-
3. Example env file can be viewed [here](https://github.com/getmaxun/maxun/blob/master/ENVEXAMPLE). Copy all content of example env to your `.env` file.
40
-
4. Choose your installation method below
41
-
42
-
### Docker Compose
43
-
1. Copy paste the [docker-compose.yml file](https://github.com/getmaxun/maxun/blob/master/docker-compose.yml) into your root folder
44
-
2. Ensure you have setup the `.env` file in that same folder
45
-
3. Run the command below from a terminal
46
-
```
47
-
docker-compose up -d
48
-
```
49
-
You can access the frontend at http://localhost:5173/ and backend at http://localhost:8080/
50
-
51
-
### Without Docker
52
-
1. Ensure you have Node.js, PostgreSQL, MinIO and Redis installed on your system.
53
-
2. Run the commands below
54
-
```
55
-
git clone https://github.com/getmaxun/maxun
56
-
57
-
# change directory to the project root
58
-
cd maxun
59
-
60
-
# install dependencies
61
-
npm install
62
-
63
-
# change directory to maxun-core to install dependencies
64
-
cd maxun-core
65
-
npm install
66
-
67
-
# get back to the root directory
68
-
cd ..
69
-
70
-
# install chromium and its dependencies
71
-
npx playwright install --with-deps chromium
72
-
73
-
# get back to the root directory
74
-
cd ..
75
-
76
-
# start frontend and backend together
77
-
npm run start
78
-
```
79
-
You can access the frontend at http://localhost:5173/ and backend at http://localhost:8080/
80
-
81
-
82
-
# Environment Variables
83
-
1. Create a file named `.env` in the root folder of the project
84
-
2. Example env file can be viewed [here](https://github.com/getmaxun/maxun/blob/master/ENVEXAMPLE).
85
-
86
-
| Variable | Mandatory | Description | If Not Set |
|`BACKEND_PORT`| Yes | Port to run backend on. Needed for Docker setup | Default value: 8080 |
89
-
|`FRONTEND_PORT`| Yes | Port to run frontend on. Needed for Docker setup | Default value: 5173 |
90
-
|`BACKEND_URL`| Yes | URL to run backend on. | Default value: http://localhost:8080|
91
-
|`VITE_BACKEND_URL`| Yes | URL used by frontend to connect to backend | Default value: http://localhost:8080|
92
-
|`PUBLIC_URL`| Yes | URL to run frontend on. | Default value: http://localhost:5173|
93
-
|`VITE_PUBLIC_URL`| Yes | URL used by backend to connect to frontend | Default value: http://localhost:5173|
94
-
|`JWT_SECRET`| Yes | Secret key used to sign and verify JSON Web Tokens (JWTs) for authentication. | JWT authentication will not work. |
95
-
|`DB_NAME`| Yes | Name of the Postgres database to connect to. | Database connection will fail. |
96
-
|`DB_USER`| Yes | Username for Postgres database authentication. | Database connection will fail. |
97
-
|`DB_PASSWORD`| Yes | Password for Postgres database authentication. | Database connection will fail. |
98
-
|`DB_HOST`| Yes | Host address where the Postgres database server is running. | Database connection will fail. |
99
-
|`DB_PORT`| Yes | Port number used to connect to the Postgres database server. | Database connection will fail. |
100
-
|`ENCRYPTION_KEY`| Yes | Key used for encrypting sensitive data (proxies, passwords). | Encryption functionality will not work. |
101
-
|`SESSION_SECRET`| No | A strong, random string used to sign session cookies | Uses default secret. Recommended to define your own session secret to avoid session hijacking. |
102
-
|`MINIO_ENDPOINT`| Yes | Endpoint URL for MinIO, to store Robot Run Screenshots. | Connection to MinIO storage will fail. |
103
-
|`MINIO_PORT`| Yes | Port number for MinIO service. | Connection to MinIO storage will fail. |
104
-
|`MINIO_CONSOLE_PORT`| No | Port number for MinIO WebUI service. Needed for Docker setup. | Cannot access MinIO Web UI. |
105
-
|`MINIO_ACCESS_KEY`| Yes | Access key for authenticating with MinIO. | MinIO authentication will fail. |
106
-
|`GOOGLE_CLIENT_ID`| No | Client ID for Google OAuth. Used for Google Sheet integration authentication. | Google login will not work. |
107
-
|`GOOGLE_CLIENT_SECRET`| No | Client Secret for Google OAuth. Used for Google Sheet integration authentication. | Google login will not work. |
108
-
|`GOOGLE_REDIRECT_URI`| No | Redirect URI for handling Google OAuth responses. | Google login will not work. |
109
-
|`AIRTABLE_CLIENT_ID`| No | Client ID for Airtable, used for Airtable integration authentication. | Airtable login will not work. |
110
-
|`AIRTABLE_REDIRECT_URI`| No | Redirect URI for handling Airtable OAuth responses. | Airtable login will not work. |
111
-
|`MAXUN_TELEMETRY`| No | Disables telemetry to stop sending anonymous usage data. Keeping it enabled helps us understand how the product is used and assess the impact of any new changes. Please keep it enabled. | Telemetry data will not be collected. |
112
-
113
-
# How Do I Self-Host?
114
-
Checkout community self hosting guide: https://docs.maxun.dev/self-host
115
-
116
-
# How Does It Work?
117
-
Maxun lets you create custom robots which emulate user actions and extract data. A robot can perform any of the actions: <b>Capture List, Capture Text or Capture Screenshot. Once a robot is created, it will keep extracting data for you without manual intervention</b>
1.[Self Host Maxun With Docker & Portainer](https://docs.maxun.dev/self-host)
41
+
2.[Upgrade Maxun With Docker Compose Setup](https://docs.maxun.dev/installation/upgrade#upgrading-with-docker-compose)
42
+
3.[Upgrade Maxun Without Docker Compose Setup](https://docs.maxun.dev/installation/upgrade#upgrading-with-local-setup)
43
+
44
+
### How Does It Work?
45
+
Maxun lets you create custom robots which emulate user actions and extract data. A robot can perform any of the actions: Capture List, Capture Text or Capture Screenshot. Once a robot is created, it will keep extracting data for you without manual intervention.
46
+
1. Capture List: Useful to extract structured and bulk items from the website.
123
47
2. Capture Text: Useful to extract individual text content from the website.
124
48
3. Capture Screenshot: Get fullpage or visible section screenshots of the website.
1. Create a root folder for your project (e.g. 'maxun')
3
+
2. Create a file named `.env` in the root folder of the project
4
+
3. Example env file can be viewed [here](https://github.com/getmaxun/maxun/blob/master/ENVEXAMPLE). Copy all content of example env to your `.env` file.
5
+
4. Choose your installation method below
6
+
7
+
### Docker Compose
8
+
1. Copy paste the [docker-compose.yml file](https://github.com/getmaxun/maxun/blob/master/docker-compose.yml) into your root folder
9
+
2. Ensure you have setup the `.env` file in that same folder
10
+
3. Run the command below from a terminal
11
+
```
12
+
docker-compose up -d
13
+
```
14
+
You can access the frontend at http://localhost:5173/ and backend at http://localhost:8080/
15
+
16
+
### Without Docker
17
+
1. Ensure you have Node.js, PostgreSQL, MinIO and Redis installed on your system.
18
+
2. Run the commands below
19
+
```
20
+
git clone https://github.com/getmaxun/maxun
21
+
22
+
# change directory to the project root
23
+
cd maxun
24
+
25
+
# install dependencies
26
+
npm install
27
+
28
+
# change directory to maxun-core to install dependencies
29
+
cd maxun-core
30
+
npm install
31
+
32
+
# get back to the root directory
33
+
cd ..
34
+
35
+
# install chromium and its dependencies
36
+
npx playwright install --with-deps chromium
37
+
38
+
# get back to the root directory
39
+
cd ..
40
+
41
+
# start frontend and backend together
42
+
npm run start
43
+
```
44
+
You can access the frontend at http://localhost:5173/ and backend at http://localhost:8080/
45
+
46
+
47
+
# Environment Variables
48
+
1. Create a file named `.env` in the root folder of the project
49
+
2. Example env file can be viewed [here](https://github.com/getmaxun/maxun/blob/master/ENVEXAMPLE).
50
+
51
+
| Variable | Mandatory | Description | If Not Set |
|`BACKEND_PORT`| Yes | Port to run backend on. Needed for Docker setup | Default value: 8080 |
54
+
|`FRONTEND_PORT`| Yes | Port to run frontend on. Needed for Docker setup | Default value: 5173 |
55
+
|`BACKEND_URL`| Yes | URL to run backend on. | Default value: http://localhost:8080|
56
+
|`VITE_BACKEND_URL`| Yes | URL used by frontend to connect to backend | Default value: http://localhost:8080|
57
+
|`PUBLIC_URL`| Yes | URL to run frontend on. | Default value: http://localhost:5173|
58
+
|`VITE_PUBLIC_URL`| Yes | URL used by backend to connect to frontend | Default value: http://localhost:5173|
59
+
|`JWT_SECRET`| Yes | Secret key used to sign and verify JSON Web Tokens (JWTs) for authentication. | JWT authentication will not work. |
60
+
|`DB_NAME`| Yes | Name of the Postgres database to connect to. | Database connection will fail. |
61
+
|`DB_USER`| Yes | Username for Postgres database authentication. | Database connection will fail. |
62
+
|`DB_PASSWORD`| Yes | Password for Postgres database authentication. | Database connection will fail. |
63
+
|`DB_HOST`| Yes | Host address where the Postgres database server is running. | Database connection will fail. |
64
+
|`DB_PORT`| Yes | Port number used to connect to the Postgres database server. | Database connection will fail. |
65
+
|`ENCRYPTION_KEY`| Yes | Key used for encrypting sensitive data (proxies, passwords). | Encryption functionality will not work. |
66
+
|`SESSION_SECRET`| No | A strong, random string used to sign session cookies | Uses default secret. Recommended to define your own session secret to avoid session hijacking. |
67
+
|`MINIO_ENDPOINT`| Yes | Endpoint URL for MinIO, to store Robot Run Screenshots. | Connection to MinIO storage will fail. |
68
+
|`MINIO_PORT`| Yes | Port number for MinIO service. | Connection to MinIO storage will fail. |
69
+
|`MINIO_CONSOLE_PORT`| No | Port number for MinIO WebUI service. Needed for Docker setup. | Cannot access MinIO Web UI. |
70
+
|`MINIO_ACCESS_KEY`| Yes | Access key for authenticating with MinIO. | MinIO authentication will fail. |
71
+
|`GOOGLE_CLIENT_ID`| No | Client ID for Google OAuth. Used for Google Sheet integration authentication. | Google login will not work. |
72
+
|`GOOGLE_CLIENT_SECRET`| No | Client Secret for Google OAuth. Used for Google Sheet integration authentication. | Google login will not work. |
73
+
|`GOOGLE_REDIRECT_URI`| No | Redirect URI for handling Google OAuth responses. | Google login will not work. |
74
+
|`AIRTABLE_CLIENT_ID`| No | Client ID for Airtable, used for Airtable integration authentication. | Airtable login will not work. |
75
+
|`AIRTABLE_REDIRECT_URI`| No | Redirect URI for handling Airtable OAuth responses. | Airtable login will not work. |
76
+
|`MAXUN_TELEMETRY`| No | Disables telemetry to stop sending anonymous usage data. Keeping it enabled helps us understand how the product is used and assess the impact of any new changes. Please keep it enabled. | Telemetry data will not be collected. |
0 commit comments