Skip to content

Commit

Permalink
1. Improves information about ports configuration
Browse files Browse the repository at this point in the history
2. Updates images for each module
  • Loading branch information
butschster committed Dec 8, 2023
1 parent bd2be00 commit 9e0c850
Show file tree
Hide file tree
Showing 11 changed files with 102 additions and 20 deletions.
2 changes: 1 addition & 1 deletion docs/.vitepress/config.mts
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ import {defineConfig} from 'vitepress'
export default defineConfig({
ignoreDeadLinks: true,
title: "Buggregator docs",
description: "A VitePress Site",
description: "Buggregator docs",
themeConfig: {
// https://vitepress.dev/reference/default-theme-config
nav: [
Expand Down
2 changes: 1 addition & 1 deletion docs/config/http-dumps.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,4 +13,4 @@ For instance, let's say you have a POST request: `http:https://[email protected]:800
server will intercept the request and capture all the relevant information. It will then display the
dumped data, allowing you to examine the request details, including the URI segments (`user/3/update` in this example).

![HTTP Requests dump server](https://github.com/spiral/docs/assets/773481/209f9c8c-00d2-4086-9f54-ce2cf8121394)
![http dumps](https://github.com/buggregator/server/assets/773481/fc823390-b490-4bbb-a787-44471eca9fb6)
2 changes: 1 addition & 1 deletion docs/config/inspector.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Buggregator is also compatible with Inspector reports, providing you with a ligh
development. With it, you can easily configure your Inspector client URL to send data directly to the server, making it
easier to identify and fix issues during the development phase.

![inspector](https://user-images.githubusercontent.com/773481/208734651-e8dca2bf-6674-4aed-b6fc-601bc877f7ce.png)
![inspector](https://github.com/buggregator/server/assets/773481/ab002ecf-e1dc-4433-90d4-0e42ff8c0ab3)

## Laravel

Expand Down
2 changes: 1 addition & 1 deletion docs/config/monolog.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ By using Buggregator's Monolog server, you can gain valuable insights into your
overall efficiency. So, whether you're a seasoned developer or just starting, the Monolog server in Buggregator is a
must-have tool for anyone serious about PHP development.

![monolog](https://user-images.githubusercontent.com/773481/208729325-b135870e-3a98-4841-90cb-6e507108a235.png)
![monolog](https://github.com/buggregator/server/assets/773481/21919110-fd4d-490d-a78e-41242d329885)

## Spiral Framework

Expand Down
2 changes: 1 addition & 1 deletion docs/config/ray.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Buggregator is compatible with `spatie/ray` package. The Ray debug tool supports
NodeJS, Go and Bash applications. After installing one of the libraries, you can use the ray function to quickly dump
stuff. Any variable(s) that you pass will be sent to the Buggregator.

![Ray debug tool](https://github.com/buggregator/spiral-app/assets/773481/c2a84d40-fc99-4bde-b87f-ea81cc1daa17)
![ray](https://github.com/buggregator/server/assets/773481/168b27f7-75b1-4837-b0a1-37146d5b8b52)

**Supported features**: Simple data, Labels, Caller, Trace, Counter, Class name of an object, Measure, Json, Xml,
Carbon, File, Table, Image, Html, Text, Notifications, Phpinfo, Exception, Show queries, Count queries, Show events,
Expand Down
2 changes: 1 addition & 1 deletion docs/config/sentry.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Buggregator offers seamless integration with Sentry reports, making it a reliabl
it, you can easily configure your Sentry DSN to send data directly to the server, providing you with a lightweight
alternative for debugging your application.

![sentry](https://user-images.githubusercontent.com/773481/208728578-1b33174b-8d1f-411a-a6fe-180a89abf06f.png)
![sentry](https://github.com/buggregator/server/assets/773481/e979fda5-54c8-42cc-8224-a1c5d828569a)

By using Buggregator to receive Sentry reports, you can identify and fix issues with your application before deploying
it to production. This ensures that your application is robust and efficient, providing a smooth experience for your
Expand Down
2 changes: 1 addition & 1 deletion docs/config/smtp.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ it effortless to test email functionality during the development phase, ensuring
before deployment. So, if you're looking for a reliable and easy-to-use email testing tool, Buggregator's fake SMTP
server is the way to go.

![smtp](https://user-images.githubusercontent.com/773481/208727862-229fda5f-3504-4377-921e-03f0ff602cb9.png)
![smtp](https://github.com/buggregator/server/assets/773481/8dd60ddf-c8d8-4a26-a8c0-b05052414a5f)

## Spiral Framework

Expand Down
2 changes: 1 addition & 1 deletion docs/config/var-dumper.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Buggregator is fully compatible with
the [Symfony VarDumper](https://symfony.com/doc/current/components/var_dumper.html#the-dump-server) component. This is a
big deal for PHP developers because it makes debugging a lot smoother and more intuitive.

![var-dumper](https://user-images.githubusercontent.com/773481/208727353-b8201775-c360-410b-b5c8-d83843d388ff.png)
![var-dumper](https://github.com/buggregator/server/assets/773481/b77fa867-0a8e-431a-9126-f69959dc18f4)

## What is Symfony VarDumper?

Expand Down
4 changes: 2 additions & 2 deletions docs/config/xhprof.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@ for PHP applications. It uses instrumentation to keep track of call counts and i
callgraph of your program during the data collection phase. In the reporting and post-processing phase, the profiler
computes exclusive metrics such as wall (elapsed) time, CPU time, and memory usage.

![xhprof](https://github.com/buggregator/server/assets/773481/d69e1158-599d-4546-96a9-40a42cb060f4)

With the Xhprof profiler, you can easily identify performance bottlenecks and optimize your application's code for
better efficiency. So, if you're looking to fine-tune your PHP application's performance, the Xhprof profiler is the
perfect tool for the job.

![xhprof](https://user-images.githubusercontent.com/773481/208724383-3790a3e1-9ebe-4616-8d4d-d1869f8f2b7c.png)

## Installation extension

One of the way to install Xhprof is to use [PECL](https://pecl.php.net/package/xhprof) package.
Expand Down
76 changes: 68 additions & 8 deletions docs/getting-started.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,23 +22,38 @@ Buggregator offers different versions for different needs:
This is the most recent officially released version, recommended for most users.

```bash
docker run --pull always -p 8000:8000 -p 1025:1025 -p 9912:9912 -p 9913:9913 ghcr.io/buggregator/server:latest
docker run --pull always \
-p 127.0.0.1:8000:8000 \
-p 127.0.0.1:1025:1025 \
-p 127.0.0.1:9912:9912 \
-p 127.0.0.1:9913:9913 \
ghcr.io/buggregator/server:latest
```

### Latest Dev Release

This version includes the latest features and updates but might be less stable.

```bash
docker run --pull always -p 8000:8000 -p 1025:1025 -p 9912:9912 -p 9913:9913 ghcr.io/buggregator/server:dev
docker run --pull always \
-p 127.0.0.1:8000:8000 \
-p 127.0.0.1:1025:1025 \
-p 127.0.0.1:9912:9912 \
-p 127.0.0.1:9913:9913 \
ghcr.io/buggregator/server:dev
```

### Specific Version

If you need a particular version of Buggregator, you can choose to install that specific one.

```bash
docker run -p 8000:8000 -p 1025:1025 -p 9912:9912 -p 9913:9913 ghcr.io/buggregator/server:v1.00
docker run \
-p 127.0.0.1:8000:8000 \
-p 127.0.0.1:1025:1025 \
-p 127.0.0.1:9912:9912 \
-p 127.0.0.1:9913:9913 \
ghcr.io/buggregator/server:v1.0
```

> **Note:**
Expand All @@ -50,17 +65,18 @@ docker run -p 8000:8000 -p 1025:1025 -p 9912:9912 -p 9913:9913 ghcr.io/buggregat
1. Create a `docker-compose.yml` file in your project directory.
2. Add the following service definition to your file:

We recommend publishing ports only on a local server, as shown in the example below:

```yaml
services:
# ...

buggregator:
image: ghcr.io/buggregator/server:dev
ports:
- 8000:8000
- 1025:1025
- 9912:9912
- 9913:9913
- 127.0.0.1:8000:8000
- 127.0.0.1:1025:1025
- 127.0.0.1:9912:9912
- 127.0.0.1:9913:9913
```

3. Run `docker-compose up` in your CLI.
Expand All @@ -73,3 +89,47 @@ interface, ready to collect and display debugging information from your applicat
And that's it! You've successfully installed it on your local machine using Docker. You can now start using it
to streamline your debugging process. If you encounter any issues or have questions, don't hesitate to refer to the
official documentation or seek help from the community.

## Port Configuration Advice:

Here are descriptions of the ports used by Buggregator:

- **8000**: This port is used for the following
modules: [HTTP Dumps](./config/http-dumps.md), [Sentry](./config/sentry.md), [Ray](./config/ray.md), [Inspector](./config/inspector.md), [XHProf](./config/xhprof.md).
- **1025**: This port is designated for [SMTP](./config/smtp.md).
- **9912**: This port is used for [Symfony Var-Dumper](./config/var-dumper.md).
- **9913**: This port is allocated for [Monolog](./config/monolog.md).

### Stay Secure

By default, the ports are set to listen only on the localhost (`127.0.0.1`), enhancing security by preventing external
access.

> **Warning**
> Publishing container ports is insecure by default, meaning when you publish a container's ports, they become available
> not only to the Docker host but also to the outside world. If you include the localhost IP address (127.0.0.1) with,
> only the Docker host can access the published container port.
If you require external access to these ports, you can remove `127.0.0.1:` from the respective port forwarding rules.
However, be cautious as this will make the ports accessible from outside your local network.

Like this:

```bashn --pull always \
-p 8000:8000 \
-p ...
ghcr.io/buggregator/server:latest
```

### Reduce the Number of Open Ports

If you're not utilizing all the features and wish to reduce the number of open ports, you can omit the unused ports from
the command. This step can help minimize the attack surface and maintain a cleaner setup.

For example, if you use only var-dumper, you can omit the other ports, like this:

```bash
docker run --pull always \
-p 127.0.0.1:9912:9912 \
ghcr.io/buggregator/server:latest
```
26 changes: 24 additions & 2 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@ Buggregator is a free, multi-purpose server tool designed primarily for debuggin
compatible with other programming languages. Think of it as a Swiss Army knife for developers. What makes it special is
that it offers a range of features that you would usually find in various paid tools, but it's available for free.

![Cover image](https://user-images.githubusercontent.com/773481/208718792-eeae35a6-c5a8-4be4-9474-2b96d222e750.png)
![Cover image](https://github.com/buggregator/server/assets/773481/47491a3c-57a3-4b40-b82e-37976afdf708)

One of the coolest things about Buggregator is how well it fits into Docker environments. If you're working with Docker,
it is like a dream come true. It's easy to integrate and really powerful.
Expand Down Expand Up @@ -49,35 +49,57 @@ application development and maintenance, all available at no cost. Here’s what

A lightweight profiler for PHP applications, helping you identify performance bottlenecks and optimize efficiency.

![xhprof](https://github.com/buggregator/server/assets/773481/d69e1158-599d-4546-96a9-40a42cb060f4)

### 2. [Symfony VarDumper Server](/config/var-dumper)

Enhances debugging by collecting and isolating dumped data, making it easier to spot issues.

![var-dumper](https://github.com/buggregator/server/assets/773481/b77fa867-0a8e-431a-9126-f69959dc18f4)

### 3. [Spatie Ray Debug Tool](/config/ray)

Supports a wide range of applications and languages, allowing for easy dumping and debugging of various data types.

![ray](https://github.com/buggregator/server/assets/773481/168b27f7-75b1-4837-b0a1-37146d5b8b52)

### 4. [Fake SMTP Server](/config/smtp)

A feature for testing email functionalities in your applications without the need for an external mail server.

![smtp](https://github.com/buggregator/server/assets/773481/8dd60ddf-c8d8-4a26-a8c0-b05052414a5f)

### 5. [Sentry Compatibility](/config/sentry)

Can replace Sentry for efficient local development, allowing you to catch and fix errors before they hit production.\
Can replace Sentry for efficient local development, allowing you to catch and fix errors before they hit production.

![sentry](https://github.com/buggregator/server/assets/773481/e979fda5-54c8-42cc-8224-a1c5d828569a)

### 6. [Monolog Server](/config/monolog)

A powerful logging tool that helps you track and analyze application logs for better insight into your application's
behavior.

![monolog](https://github.com/buggregator/server/assets/773481/21919110-fd4d-490d-a78e-41242d329885)

### 7. [Inspector Compatibility](/config/inspector)

Works with Inspector reports, offering a streamlined alternative for local development and debugging.

![inspector](https://github.com/buggregator/server/assets/773481/ab002ecf-e1dc-4433-90d4-0e42ff8c0ab3)

### 8. [HTTP Requests Dump Server](/config/http-dumps)

A valuable tool for capturing and analyzing HTTP requests, aiding in the debugging and development process.

![http dumps](https://github.com/buggregator/server/assets/773481/fc823390-b490-4bbb-a787-44471eca9fb6)

### 9. Dumps sharing

You can share dumps with your colleagues or friends. Just click on the share button and copy your dump as an image.

![share](https://github.com/buggregator/server/assets/773481/a524ffcb-8208-4b89-96b8-9c9199142f51)

---

Buggregator is designed with simplicity and efficiency in mind, requiring no additional packages for its operation. This
Expand Down

0 comments on commit 9e0c850

Please sign in to comment.