Skip to content

Commit 919261c

Browse files
committed
minor updates to Security.md and docker_build.md
1 parent 3cd4dad commit 919261c

File tree

2 files changed

+15
-38
lines changed

2 files changed

+15
-38
lines changed

.github/SECURITY.md

+6-8
Original file line numberDiff line numberDiff line change
@@ -11,14 +11,12 @@ Swirl supports the following versions of the Swirl Community and Swirl Enterpris
1111

1212
## Reporting a Vulnerability
1313

14-
To report a security vulnerability to the Swirl team, please email [email protected] with the
15-
word "SECURITY" in the title.
14+
To report a security vulnerability to the Swirl team, please email [[email protected]](mailto:[email protected]) with the word `SECURITY` in the Subject of your message.
1615

1716
In the email body please provide:
18-
* your contact information (full name, phone number)
19-
* a brief description of the vulnerability being reported
20-
* the affected version of Swirl
21-
* a detailed description of how to reproduce it (screenshots if possible)
17+
* Your contact information (full name, phone number)
18+
* A brief description of the vulnerability being reported
19+
* The affected version of Swirl
20+
* A detailed description of how to reproduce it (including screen shots, if possible)
2221

23-
With this information, the Swirl Security Team will respond within 72 hours of receipt of this
24-
email.
22+
With this information, the Swirl Security Team will respond within 72 hours of receipt of this email.

docs/DOCKER_BUILD.md

+9-30
Original file line numberDiff line numberDiff line change
@@ -5,11 +5,12 @@ nav_exclude: true
55
search_exclude: true
66
---
77

8-
# DOCKER BUILD for Swirl Metasearch <img alt='Swirl Metasearch Logo' src='https://raw.githubusercontent.com/wiki/swirlai/swirl-search/images/swirl-logo-only-blue.png' width=38 align=left />
8+
# DOCKER BUILD for Swirl
99

10-
:warning: Warning: when using Docker the Swirl database is instantly and irrevocably deleted upon container shutdown!
10+
{: .warning }
11+
The Docker version of Swirl does *not* retain any data or configuration when shut down!
1112

12-
Please [contact support](#support) for a Docker image suitable for production deployment.
13+
Please [contact support](mailto:support@swirl.today) for a Docker image suitable for production deployment.
1314

1415
<br/>
1516

@@ -49,7 +50,7 @@ This command should produce a long response starting with:
4950
...etc...
5051
```
5152

52-
If you see any error messages, please [contact support](#support) for assistance.
53+
If you see any error messages, please [contact support](mailto:support@swirl.today) for assistance.
5354

5455
<br/>
5556

@@ -74,7 +75,7 @@ The Container ID in this example is `swirl-c-app-1`. It will be different if you
7475

7576
Moments later, Docker desktop will reflect the running Container:
7677

77-
![Swirl running in Docker](https://raw.githubusercontent.com/wiki/swirlai/swirl-search/images/swirl_docker.png)
78+
![Swirl running in Docker](https://docs.swirl.today/images/swirl_docker.png)
7879

7980
<br/>
8081

@@ -129,13 +130,10 @@ After 5-7 seconds, this should bring up a unified, relevancy ranked result list:
129130

130131
## Notes
131132

132-
:warning: Warning: when using Docker the Swirl database is instantly and irrevocably deleted upon container shutdown!
133+
{: .warning }
134+
Swirl in Docker cannot use localhost to connect to local endpoints!
133135

134-
Please [contact support](#support) for a Docker image suitable for production deployment.
135-
136-
**Important: Swirl in Docker cannot use localhost to connect to local endpoints!**
137-
138-
For example: if you have solr running on localhost:8983, Swirl will be unable to contact it from inside the Docker container using that URL.
136+
For example: If you have solr running on localhost:8983, Swirl will be unable to contact it from inside the Docker container using that URL.
139137

140138
To configure such a source, get the hostname. On OS/X:
141139

@@ -149,22 +147,3 @@ In the SearchProvider configuration, replace localhost with the hostname:
149147
```
150148
"url": "http://AgentCooper.local:8983/solr/{collection}/select?wt=json",
151149
```
152-
153-
<br/>
154-
155-
## Documentation
156-
157-
* [Quick Start Guide](https://github.com/swirlai/swirl-search/wiki/1.-Quick-Start)
158-
* [User Guide](https://github.com/swirlai/swirl-search/wiki/2.-User-Guide)
159-
* [Admin Guide](https://github.com/swirlai/swirl-search/wiki/3.-Admin-Guide)
160-
* [M365 Guide](https://github.com/swirlai/swirl-search/wiki/4.-M365-Guide)
161-
* [Developer Guide](https://github.com/swirlai/swirl-search/wiki/5.-Developer-Guide)
162-
* [Developer Reference](https://github.com/swirlai/swirl-search/wiki/6.-Developer-Reference)
163-
164-
<br/>
165-
166-
# Support
167-
168-
:small_blue_diamond: [Join Swirl SEARCH #support on Slack!](https://join.slack.com/t/swirlmetasearch/shared_invite/zt-1qk7q02eo-kpqFAbiZJGOdqgYVvR1sfw)
169-
170-
:small_blue_diamond: Email: [[email protected]](mailto:[email protected]) with issues, requests, questions, etc - we'd love to hear from you!

0 commit comments

Comments
 (0)