diff --git a/docs/faq.md b/docs/faq.md index 0d3e4be..9460f3c 100644 --- a/docs/faq.md +++ b/docs/faq.md @@ -11,6 +11,7 @@ sidebar_position: 100 No, OpenBullet 2 can read `.loli` configs, except for a few specific blocks or settings. You can simply import a `.loli` config inside OpenBullet 2 and it will automatically repackage it into the `.opk` format. You can also drop the config in the `UserData/Configs` folder and perform a rescan to achieve the same thing. The following features are **not supported**: +- editing the config through *Stacker*, only raw *LoliScript* code - a few config settings from the old OB1 system - the *MOUSEACTION* command - the *CFBypass* block diff --git a/docs/jobs/job-monitor.md b/docs/jobs/job-monitor.md index e69de29..7f2f280 100644 --- a/docs/jobs/job-monitor.md +++ b/docs/jobs/job-monitor.md @@ -0,0 +1,5 @@ +--- +sidebar_label: 'Job Monitor' +sidebar_position: 2 +--- + diff --git a/docs/jobs/multi-run-job/running.md b/docs/jobs/multi-run-job/running.md index f5e48cc..92b63fb 100644 --- a/docs/jobs/multi-run-job/running.md +++ b/docs/jobs/multi-run-job/running.md @@ -6,32 +6,28 @@ sidebar_position: 2 # Running a Multi Run Job ### Setup -For this guide, you will need to create a Multi Run Job with the given options (you can read the [creation guide](./creation.md) to know more about all the available options): +For this guide, you will need to create a Multi Run Job by going to the *Jobs* tab, clicking on *New* and selecting *Multi Run Job*. You can read the [creation guide](./creation.md) to know more about all the available options. We will use the following options: - config: [sample config](/download/Test.opk) - 5 bots - data pool: range from 0 to 100 with step 1, Default wordlist type -At this point, you will see something like this +Leave everything else default. Your options need to look like these: + +![Sample settings](/img/jobs/multi-run-job/sample-settings.png) + +Finally, click on the *Create Job* button. At this point, you should see something like this ![Multi Run Job Viewer (idle)](/img/jobs/multi-run-job/viewer-idle.png) -On the left, you can see most of the options that you previously configured. You can now do the following things: +In the *Job options* section, you can see most of the options that you previously configured. You can now do the following things: - Change the options of the job (only when idle) - Change the number of bots (also while running) - Start the job -If you click on start you will see the progress bar filling up and some hits being obtained +If you click on *Start* you will see the progress bar filling up, the logs being printed and some hits being obtained ![Multi Run Job (running)](/img/jobs/multi-run-job/viewer-running.png) -You can go to the *OB Settings* section and tick the following option to enable real-time logging as data gets checked. - -![Enable job log](/img/jobs/multi-run-job/enable-logging.png) - -Now run the job again, you will see something like this - -![Multi Run Job (running with log)](/img/jobs/multi-run-job/viewer-running-log.png) - :::info INFO If you want to run the job again, you will need to rewind the *skip* value to the beginning, so click on the *Change* button and set the *skip* back to 0 before attempting to start the job again. ::: @@ -39,7 +35,7 @@ If you want to run the job again, you will need to rewind the *skip* value to th ### Stats Overview #### Data | Name | Explanation | -|---------------|--------------------------------------------------------| +|:--------------|:-------------------------------------------------------| |**Tested** |The number of data lines that have been tested so far | |**Hits** |How many times the bot ended with a `SUCCESS` status | |**Custom** |How many times the bot ended with `CUSTOM` or another custom status| @@ -52,7 +48,7 @@ If you want to run the job again, you will need to rewind the *skip* value to th #### Proxy | Name | Explanation | -|---------------|--------------------------------------------------------| +|:--------------|:-------------------------------------------------------| |**Total** |The total number of proxies that are currently in the pool | |**Alive** |The number of proxies that are still alive and are able to be assigned to bots| |**Bad** |*Not implemented yet*| @@ -60,7 +56,7 @@ If you want to run the job again, you will need to rewind the *skip* value to th #### Others | Name | Explanation | -|-------------------|--------------------------------------------------------| +|:------------------|:-------------------------------------------------------| |**CPM** |The number of checks per minute| |**Captcha Credit** |The remaining captcha credit (if the config uses a captcha service)| |**Elapsed** |The time elapsed since the beginning of the run| @@ -68,16 +64,13 @@ If you want to run the job again, you will need to rewind the *skip* value to th |**Progress** |The overall progress of the check (includes the *skip*)| ### Controls - -![Controls](/img/jobs/multi-run-job/controls.png) - During the run, you are able to - **Pause** the job and resume it later. When you click pause, the job waits until all bots finished processing their assigned items before going into a paused state - **Stop** the job. When you click stop, the job waits until all bots finished processing their assigned items before going into an idle state - **Abort** the job. When you click abort, the job will abruptly terminate all bots and you might lose the outcome of the ongoing checks :::info INFO -In the job options, you can enable the *mark as to check on abort* option to make the current items go to *To check* when you click abort, so that you can check them manually or include them in the next run if needed. +In the job options, you can enable the *mark as to check on abort* option to make the current items go to *To Check* when you click abort, so that you can check them manually or include them in the next run if needed. ::: :::caution WARNING @@ -85,26 +78,16 @@ If a bot is stuck in a *ban loop* (for example because it keeps ending with an ` ::: ### Hits -By default, a job will save hits, custom and to check results to memory, in addition to sending them to the *hit outputs* you configured. You can see the hits right below a job in the job viewer page. +By default, a job will save hits, custom and to check results to memory, in addition to sending them to the *hit outputs* you configured. You can see the hits the job obtained in the bottom-right area of the page. ![Hits](/img/jobs/multi-run-job/hits.png) You can select more than one hit by using the CTRL or SHIFT keys on your keyboard to add individual items or entire ranges to the selection, respectively. You can then copy the data from the hits and paste it where you want. -:::caution WARNING -If you are using the web client without HTTPS, your browser will show you this error - -![Hits](/img/jobs/multi-run-job/clipboard-error.png) - -To solve this problem you can either enable unsecure sources in the browser or use something like [ngrok or cloudflared](https://discourse.openbullet.dev/t/your-openbullet-online/925) -::: - -You are also able to *send* the hit (along with the proxy and wordlist type) to the *debugger*, and *show the full log* of the hit. The full log is only saved if you enable this option in the *RL Settings* section. - -![Enable bot logging](/img/jobs/multi-run-job/enable-bot-logging.png) +You are also able to *send* the hit (along with the proxy and wordlist type) to the *debugger*, and *show the full log* of the hit. The full log is only saved if you enable this option in the *RL Settings* section. Also, bot logs are only available to the admin user. :::caution WARNING -Bot logs can be huge and eat up a lot of your RAM, so only enable them while debugging a config (for example to check why something ended up as *To check* instead of another result). Do not leave it enabled while checking a high amount of data lines, otherwise you will run into problems. +Bot logs can be huge and eat up a lot of your RAM, so only enable them while debugging a config (for example to check why something ended up as *To check* instead of another result). Do not leave it enabled while checking a high amount of data lines, otherwise you will run into memory issues. ::: ![Bot log](/img/jobs/multi-run-job/bot-log.png) diff --git a/static/img/jobs/multi-run-job/ban-loop-evasion.png b/static/img/jobs/multi-run-job/ban-loop-evasion.png deleted file mode 100644 index e728eaa..0000000 Binary files a/static/img/jobs/multi-run-job/ban-loop-evasion.png and /dev/null differ diff --git a/static/img/jobs/multi-run-job/bot-log.png b/static/img/jobs/multi-run-job/bot-log.png index 87e2592..2c158a8 100644 Binary files a/static/img/jobs/multi-run-job/bot-log.png and b/static/img/jobs/multi-run-job/bot-log.png differ diff --git a/static/img/jobs/multi-run-job/clipboard-error.png b/static/img/jobs/multi-run-job/clipboard-error.png deleted file mode 100644 index c20ea78..0000000 Binary files a/static/img/jobs/multi-run-job/clipboard-error.png and /dev/null differ diff --git a/static/img/jobs/multi-run-job/controls.png b/static/img/jobs/multi-run-job/controls.png deleted file mode 100644 index a9518f8..0000000 Binary files a/static/img/jobs/multi-run-job/controls.png and /dev/null differ diff --git a/static/img/jobs/multi-run-job/enable-bot-logging.png b/static/img/jobs/multi-run-job/enable-bot-logging.png deleted file mode 100644 index 956cf58..0000000 Binary files a/static/img/jobs/multi-run-job/enable-bot-logging.png and /dev/null differ diff --git a/static/img/jobs/multi-run-job/enable-logging.png b/static/img/jobs/multi-run-job/enable-logging.png deleted file mode 100644 index b4072e2..0000000 Binary files a/static/img/jobs/multi-run-job/enable-logging.png and /dev/null differ diff --git a/static/img/jobs/multi-run-job/hits.png b/static/img/jobs/multi-run-job/hits.png index 2e5e265..84889f9 100644 Binary files a/static/img/jobs/multi-run-job/hits.png and b/static/img/jobs/multi-run-job/hits.png differ diff --git a/static/img/jobs/multi-run-job/sample-settings.png b/static/img/jobs/multi-run-job/sample-settings.png new file mode 100644 index 0000000..8074e84 Binary files /dev/null and b/static/img/jobs/multi-run-job/sample-settings.png differ diff --git a/static/img/jobs/multi-run-job/viewer-idle.png b/static/img/jobs/multi-run-job/viewer-idle.png index 4e644c2..761b549 100644 Binary files a/static/img/jobs/multi-run-job/viewer-idle.png and b/static/img/jobs/multi-run-job/viewer-idle.png differ diff --git a/static/img/jobs/multi-run-job/viewer-running-log.png b/static/img/jobs/multi-run-job/viewer-running-log.png deleted file mode 100644 index 9f525ff..0000000 Binary files a/static/img/jobs/multi-run-job/viewer-running-log.png and /dev/null differ diff --git a/static/img/jobs/multi-run-job/viewer-running.png b/static/img/jobs/multi-run-job/viewer-running.png index fb48ea6..62a49ce 100644 Binary files a/static/img/jobs/multi-run-job/viewer-running.png and b/static/img/jobs/multi-run-job/viewer-running.png differ