Skip to content
This repository was archived by the owner on Nov 26, 2024. It is now read-only.

Commit 1d7e992

Browse files
author
Michel Casabianca
committed
Fixed documentation for cache order
1 parent 6b77050 commit 1d7e992

1 file changed

Lines changed: 18 additions & 18 deletions

File tree

README.md

Lines changed: 18 additions & 18 deletions
Original file line numberDiff line numberDiff line change
@@ -94,47 +94,47 @@ Note that without API key, you will be limited to *10* requests in a rolling *60
9494

9595
A cache is useful because if you perform more call to NVD database that allowed, your calls will significantly slow down. Gobinsec tries to build caches in this order:
9696

97-
### Memcachier
97+
### Memcached
9898

99-
A cache is built with *Memcachier* if following section is found in configuration file:
99+
If no configuration is found for *Memcachier*, it will try to build a cache for *Memcached*, if following section is found in configuration file:
100100

101101
```yaml
102-
memcachier:
102+
memcached:
103103
address: ...
104104
expiration: ...
105-
username: ...
106-
password: ...
107105
```
108106
109-
Else, il will look for following environment variables:
107+
Else it will look for following environment variables:
110108
111109
```
112-
MEMCACHIER_ADDRESS
113-
MEMCACHIER_EXPIRATION
114-
MEMCACHIER_USERNAME
115-
MEMCACHIER_PASSWORD
110+
MEMCACHED_ADDRESS
111+
MEMCACHED_EXPIRATION
116112
```
117113

118-
[Memcachier](https://www.memcachier.com) is an online cache provider with free tiers.
114+
A sample [docker-compose.yml](https://github.com/intercloud/gobinsec/blob/main/docker-compose.yml) file to start a *memcached* instance is provided in this project.
119115

120-
### Memcached
116+
### Memcachier
121117

122-
If no configuration is found for *Memcachier*, it will try to build a cache for *Memcached*, if following section is found in configuration file:
118+
A cache is built with *Memcachier* if following section is found in configuration file:
123119

124120
```yaml
125-
memcached:
121+
memcachier:
126122
address: ...
127123
expiration: ...
124+
username: ...
125+
password: ...
128126
```
129127
130-
Else it will look for following environment variables:
128+
Else, il will look for following environment variables:
131129
132130
```
133-
MEMCACHED_ADDRESS
134-
MEMCACHED_EXPIRATION
131+
MEMCACHIER_ADDRESS
132+
MEMCACHIER_EXPIRATION
133+
MEMCACHIER_USERNAME
134+
MEMCACHIER_PASSWORD
135135
```
136136

137-
A sample [docker-compose.yml](https://github.com/intercloud/gobinsec/blob/main/docker-compose.yml) file to start a *memcached* instance is provided in this project.
137+
[Memcachier](https://www.memcachier.com) is an online cache provider with free tiers.
138138

139139
### Memory
140140

0 commit comments

Comments
 (0)