Skip to content

Commit 061cf82

Browse files
committed
docs(installation): update installation following segmentation issue
1 parent eee6074 commit 061cf82

File tree

2 files changed

+38
-21
lines changed

2 files changed

+38
-21
lines changed

Diff for: README.md

+32-20
Original file line numberDiff line numberDiff line change
@@ -23,12 +23,14 @@
2323

2424
</div>
2525

26-
## Code security scanner that natively filters and prioritizes security risks using sensitive data flow analysis.
26+
## Code security scanner that natively filters and prioritizes security risks using sensitive data flow analysis
27+
2728
<hr/>
2829

29-
https://user-images.githubusercontent.com/1649672/230438696-9bb0fd35-2aa9-4273-9970-733189d01ff1.mp4
30+
<https://user-images.githubusercontent.com/1649672/230438696-9bb0fd35-2aa9-4273-9970-733189d01ff1.mp4>
3031

3132
Bearer provides built-in rules against a common set of security risks and vulnerabilities, known as [OWASP Top 10](https://owasp.org/www-project-top-ten/). Here are some practical examples of what those rules look for:
33+
3234
* Non-filtered user input.
3335
* Leakage of sensitive data through cookies, internal loggers, third-party logging services, and into analytics environments.
3436
* Usage of weak encryption libraries or misusage of encryption algorithms.
@@ -54,6 +56,7 @@ curl -sfL https://raw.githubusercontent.com/Bearer/bearer/main/contrib/install.s
5456
```
5557

5658
#### Other install options
59+
5760
<details>
5861
<summary>Homebrew</summary>
5962

@@ -64,33 +67,41 @@ curl -sfL https://raw.githubusercontent.com/Bearer/bearer/main/contrib/install.s
6467
```
6568

6669
Update an existing installation with the following:
67-
70+
6871
```bash
6972
brew update && brew update bearer/tap/bearer
7073
```
74+
7175
</details>
7276

7377
<details>
7478
<summary>Debian/Ubuntu</summary>
7579

7680
```shell
77-
$ sudo apt-get install apt-transport-https
78-
$ echo "deb [trusted=yes] https://apt.fury.io/bearer/ /" | sudo tee -a /etc/apt/sources.list.d/fury.list
79-
$ sudo apt-get update
80-
$ sudo apt-get install bearer
81+
sudo apt-get install apt-transport-https
82+
echo "deb [trusted=yes] https://apt.fury.io/bearer/ /" | sudo tee -a /etc/apt/sources.list.d/fury.list
83+
sudo apt-get update
84+
sudo apt-get install bearer
8185
```
8286

8387
Update an existing installation with the following:
88+
8489
```bash
8590
sudo apt-get update
8691
sudo apt-get install bearer
8792
```
93+
94+
**Known issues**
95+
96+
- We are currently investigating an [issue](https://github.com/Bearer/bearer/issues/899) which would prevent Bearer to run correctly. If you encounter this bug, we recommend following the Docker installation instructions.
97+
8898
</details>
8999

90100
<details>
91101
<summary>RHEL/CentOS</summary>
92102

93103
Add repository setting:
104+
94105
```shell
95106
$ sudo vim /etc/yum.repos.d/fury.repo
96107
[fury]
@@ -101,15 +112,18 @@ curl -sfL https://raw.githubusercontent.com/Bearer/bearer/main/contrib/install.s
101112
```
102113

103114
Then install with yum:
115+
104116
```shell
105-
$ sudo yum -y update
106-
$ sudo yum -y install bearer
117+
sudo yum -y update
118+
sudo yum -y install bearer
107119
```
108120

109121
Update an existing installation with the following:
122+
110123
```bash
111124
sudo yum -y update bearer
112125
```
126+
113127
</details>
114128

115129
<details>
@@ -179,9 +193,9 @@ By default the `scan` command use the SAST scanner, other [scanner types](https:
179193

180194
The security report is an easily digestible view of the security issues detected by Bearer. A report is made up of:
181195

182-
- The list of [rules](https://docs.bearer.com/reference/rules/) run against your code.
183-
- Each detected finding, containing the file location and lines that triggered the rule finding.
184-
- A stat section with a summary of rules checks, findings and warnings.
196+
* The list of [rules](https://docs.bearer.com/reference/rules/) run against your code.
197+
* Each detected finding, containing the file location and lines that triggered the rule finding.
198+
* A stat section with a summary of rules checks, findings and warnings.
185199

186200
The [OWASP Juice Shop](https://github.com/juice-shop/juice-shop) example application will trigger rule findings and output a full report. Here's a section of the output:
187201

@@ -207,7 +221,6 @@ LOW: 0
207221
WARNING: 0
208222
```
209223

210-
211224
The security report is just one [report type](https://docs.bearer.com/explanations/reports) available in Bearer.
212225

213226
Ready for the next step? Additional options for using and configuring the `scan` command can be found in [configuring the scan command](https://docs.bearer.com/guides/configure-scan/).
@@ -240,7 +253,7 @@ In addition, running Bearer on a scheduled job is a great way to keep track of y
240253

241254
### Supported Language
242255

243-
Bearer currently supports JavaScript, TypeScript and Ruby and their associated most used frameworks and libraries.
256+
Bearer currently supports JavaScript, TypeScript and Ruby and their associated most used frameworks and libraries.
244257
Java support is under active development, more languages will follow.
245258

246259
### What makes Bearer different from any other SAST tools?
@@ -269,11 +282,11 @@ By using the most modern static code analysis techniques and providing a native
269282

270283
Thanks for using Bearer. Still have questions?
271284

272-
- Start with the [documentation](https://docs.bearer.com).
273-
- Have a question or need some help? Find the Bearer team on [Discord][discord].
274-
- Got a feature request or found a bug? [Open a new issue](https://github.com/Bearer/bearer/issues/new/choose).
275-
- Found a security issue? Check out our [Security Policy](https://github.com/Bearer/bearer/security/policy) for reporting details.
276-
- Find out more at [Bearer.com](https://www.bearer.com)
285+
* Start with the [documentation](https://docs.bearer.com).
286+
* Have a question or need some help? Find the Bearer team on [Discord][discord].
287+
* Got a feature request or found a bug? [Open a new issue](https://github.com/Bearer/bearer/issues/new/choose).
288+
* Found a security issue? Check out our [Security Policy](https://github.com/Bearer/bearer/security/policy) for reporting details.
289+
* Find out more at [Bearer.com](https://www.bearer.com)
277290

278291
## :handshake: Contributing
279292

@@ -299,5 +312,4 @@ You are not allowed to provide Bearer to third parties as a hosted or managed se
299312
[test-img]: https://github.com/Bearer/bearer/actions/workflows/test.yml/badge.svg
300313
[release]: https://github.com/Bearer/bearer/releases
301314
[release-img]: https://img.shields.io/github/release/Bearer/bearer.svg?logo=github
302-
[github-all-releases-img]: https://img.shields.io/github/downloads/Bearer/bearer/total?logo=github
303315
[discord]: https://discord.gg/eaHZBJUXRF

Diff for: docs/reference/installation.md

+6-1
Original file line numberDiff line numberDiff line change
@@ -44,6 +44,10 @@ sudo apt-get update
4444
sudo apt-get install bearer
4545
```
4646

47+
**Known issues**
48+
49+
- We are currently investigating an [issue](https://github.com/Bearer/bearer/issues/899) which would prevent Bearer to run correctly. If you encounter this bug, we recommend following the Docker installation instructions.
50+
4751
### RHEL/CentOS
4852

4953
Add repository setting:
@@ -132,6 +136,7 @@ sudo yum -y update bearer
132136
```
133137

134138
### Docker
139+
135140
The Docker configurations above uses the latest release, but you may need to tell Docker to explicitly retrieve the latest image:
136141

137142
```bash
@@ -140,4 +145,4 @@ docker image pull bearer/bearer:latest-amd64
140145

141146
### Binary
142147

143-
To update Bearer when using the binary, download the latest release and overwrite your existing installation location.
148+
To update Bearer when using the binary, download the latest release and overwrite your existing installation location.

0 commit comments

Comments
 (0)