Skip to content

Commit

Permalink
Add FAQ (arriven#178)
Browse files Browse the repository at this point in the history
* Rm doc arriven#146

* Trigger notification

* Add FAQ

* fix misspell

* small fix

* Run installer test only if changed

* Add link to FAQ to readme

* fix PR
  • Loading branch information
Amet13 authored Mar 6, 2022
1 parent 81e08a5 commit 1242963
Show file tree
Hide file tree
Showing 6 changed files with 56 additions and 226 deletions.
2 changes: 2 additions & 0 deletions .github/workflows/test-installer.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,8 @@ on:
branches:
- "main"
pull_request:
paths:
- 'install.sh'

name: Test install.sh
jobs:
Expand Down
39 changes: 39 additions & 0 deletions FAQ.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# Frequently asked questions

## Where can I find advanced documentation?

See [docs/](docs/)

## I installed `db1000n` but it's not working properly. What to do?

Create [Issue](https://github.com/Arriven/db1000n/issues) and community will help you with solving a problem

## I'm not a developer, how can I help to project?

- Share information about `db1000n` in social media, with your friends and colleagues
- Run `db1000n` on every possible platform (local machine, public clouds, Docker, Kubernetes, etc)
- Create [Issues](https://github.com/Arriven/db1000n/issues) or [Pull Requests](https://github.com/Arriven/db1000n/pulls) if you found any bugs, missed documentation, misspells, etc

## I'm a developer, how can I help to project?

- Check [Issues](https://github.com/Arriven/db1000n/issues) to help with important tasks
- Check our codebase and make [PRs](https://github.com/Arriven/db1000n/pulls)
- Test an app on different platforms and report bugs or feature requests

## When I run `db1000n` I see that it generates low amount of traffic. Isn't that bad?

TL;DR: it's okay

The app is configurable to generate set amount of traffic (controlled by the number of targets, their type, and attack interval for each of them).
The main reason it works that way is because there are two main types of ddos:

- Straightforward load generation (easy to implement, easy to defend from) - as effective as the amount of raw traffic you can generate

- Actual denial of service that aims to remain as undetected as possible by simulating plausible traffic and hitting concrete vulnerabilities in the target (or targets). This type of ddos doesn't require a lot of traffic and thus is mostly limited by the amount of clients generating this type of load (or rather unique IPs)

## Should I care about costs if I run an app in public cloud?

TL;DR: [yes](https://github.com/Arriven/db1000n/issues/153)

Cloud providers could charge a huge amount of money not only for compute resources but for traffic as well.
If you run an app in the cloud please control your billing
10 changes: 7 additions & 3 deletions README-ua.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ _This README in English: [README.md](README.md)_

### Використовуємо VPN (якщо ви в Україні)!

- Переключіть VPN на Росію, якщо це можливо.
- Переключіть VPN на Росію, якщо це можливо
- Не використовуйте Україну як локацию VPN!
- Будь яка інша країна - теж добре.
- Будь яка інша країна - теж добре
- Бережіть себе!

### Для новачків
Expand Down Expand Up @@ -53,7 +53,7 @@ _This README in English: [README.md](README.md)_
### Бінарний файл

Завантажте [останній реліз](https://github.com/Arriven/db1000n/releases/latest) згідно вашої архітектури/ОС.
Розпакуйте архів та запустіть файл.
Розпакуйте архів та запустіть файл

### Docker

Expand All @@ -73,6 +73,10 @@ docker run ghcr.io/arriven/db1000n
Наші експерти координують атаки без вашої активної участі.
Дякуємо вам за допомогу!

## Я все ще маю питання

Ви можете знайти деякі відповіді на сторінці [FAQ.md](FAQ.md) (англійською)

## Контакти

- [Група в телеграмі](https://t.me/ddos_separ)
Expand Down
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,9 @@ _Ви можете читати цю сторінку українською: [R

### Use VPN (if you are in Ukraine)!

- Switch to Russia if possible.
- Switch to Russia if possible
- Don't use Ukraine as a VPN location!
- But any other country or VPN location is okay.
- But any other country or VPN location is okay
- Stay safe!

### For dummies
Expand Down Expand Up @@ -53,7 +53,7 @@ There are different ways to install and run `db1000n`
### Binary file

Download the [latest release](https://github.com/Arriven/db1000n/releases/latest) for your arch/OS.
Unpack the archive and run it.
Unpack the archive and run it

### Docker run

Expand All @@ -73,6 +73,10 @@ You need to keep your computer active, use VPN and make sure that the applicatio
Our experts coordinate our attacks remotely without disturbing and interrupting you.
Thanks for your help!

## I still have questions

You will find some answers on our [FAQ.md](FAQ.md)

## Contacts

- [Main telegram group](https://t.me/ddos_separ)
Expand Down
219 changes: 0 additions & 219 deletions docs/README.md

This file was deleted.

2 changes: 1 addition & 1 deletion kubernetes/helm-charts/README.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# db1000n Helm chart

*If you want to use plain manifess, see manifests [here](../manifests/)*
*If you want to use plain manifests, see manifests [here](../manifests/)*

This is a Helm chart for Kubernetes

Expand Down

0 comments on commit 1242963

Please sign in to comment.