Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve README #1775

Open
wants to merge 5 commits into
base: master
Choose a base branch
from
Open

Improve README #1775

Changes from 1 commit
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
c682a0a
style: remove blank lines
AnonymousWP Apr 12, 2023
75e7852
docs(readme): add Docker steps
AnonymousWP Apr 12, 2023
0054c25
docs(readme): add numbered list for steps
AnonymousWP Apr 12, 2023
a709c9a
docs(readme): change Docker command
AnonymousWP Apr 13, 2023
d088491
docs(readme): add Docker full build command
AnonymousWP Apr 17, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
docs(readme): add numbered list for steps
  • Loading branch information
@AnonymousWP
AnonymousWP committed Apr 12, 2023
commit 0054c256236eb8134d4aa71c4721d3fdb2fa544e
55 changes: 39 additions & 16 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -94,28 +94,51 @@ To install and run SpiderFoot, you need at least Python 3.7 and a number of Pyth

#### Stable build (packaged release)

```bash
wget https://github.com/smicallef/spiderfoot/archive/v4.0.tar.gz
tar zxvf v4.0.tar.gz
cd spiderfoot-4.0
pip3 install -r requirements.txt
python3 ./sf.py -l 127.0.0.1:5001
```
1. Download the package and unpack it

```bash
wget https://github.com/smicallef/spiderfoot/archive/v4.0.tar.gz && tar zxvf v4.0.tar.gz && cd spiderfoot-4.0
```

1. Install the requirements
Copy link
Owner

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Step numbering is not increasing here and below.

Copy link
Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Are you sure you're not confused? As you can see in my branch, it does: https://github.com/AnonymousWP/spiderfoot/tree/Improve-readme#stable-build-packaged-release. Maybe you think it should increase the number, but some actions (e.g. "Docker stable build (packaged release)" for example) have only one step to be followed. Because of the small header, it's unclear it's about a new step maybe. That's why I also recommend starting with H1 -> H2 -> H3, etc.


```bash
pip3 install -r requirements.txt
```

1. Run the webserver

```bash
python3 ./sf.py -l 127.0.0.1:5001
```

#### Development build (cloning git master branch)

```bash
git clone https://github.com/smicallef/spiderfoot.git
cd spiderfoot
pip3 install -r requirements.txt
python3 ./sf.py -l 127.0.0.1:5001
```
1. Clone the repository

```bash
git clone https://github.com/smicallef/spiderfoot.git && cd spiderfoot
```

1. Install the requirements

```bash
pip3 install -r requirements.txt
```

1. Run the webserver

```bash
python3 ./sf.py -l 127.0.0.1:5001
```

#### Docker stable build (packaged release)

```bash
sudo docker compose up -d
```
1. Run the Docker Compose file

```bash
sudo docker compose up -d
```

#### Docker development build

Expand Down