Skip to content

Commit

Permalink
doc: add notes about extras
Browse files Browse the repository at this point in the history
  • Loading branch information
Snawoot committed May 23, 2019
1 parent 8833e2b commit 400821c
Showing 1 changed file with 7 additions and 3 deletions.
10 changes: 7 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -32,9 +32,11 @@ All dependency packages installed automatically if this package is installed via
Run:

```bash
sudo python3 -m pip install postfix-mta-sts-resolver
sudo python3 -m pip install postfix-mta-sts-resolver[redis,sqlite]
```

If you don't need `redis` or `sqlite` support, you may omit one of them in square brackets. If you don't need any of them and you plan to use internal cache without persistence, you should also omit square brackets.

Package scripts shall be available in standard executable locations upon completion.

#### pip user install
Expand All @@ -46,9 +48,11 @@ All pip invocations can be run with `--user` option of `pip` installer. In this
Run in project directory:

```bash
sudo python3 -m pip install .
sudo python3 -m pip install .[redis,sqlite]
```

If you don't need `redis` or `sqlite` support, you may omit one of them in square brackets. If you don't need any of them and you plan to use internal cache without persistence, you should also omit square brackets.

Package scripts shall be available in standard executable locations upon completion.


Expand Down Expand Up @@ -190,7 +194,7 @@ Some people may find convenient to install latest python from source into `/opt`
Python binaries will be available in `/opt/bin`, including `pip3`. You may install `postfix-mta-sts-resolver` using `/opt/bin/pip3` without interference with any system packages:

```bash
sudo /opt/bin/pip3 install postfix-mta-sts-resolver
sudo /opt/bin/pip3 install postfix-mta-sts-resolver[sqlite,redis]
```

Executable files of `postfix-mta-sts-resolver` will be available in `/opt/bin/mta-sts-query` and `/opt/bin/mta-sts-daemon`
Expand Down

0 comments on commit 400821c

Please sign in to comment.