Merge remote-tracking branch 'origin/master' into heroku-app
This commit is contained in:
commit
4bb9eb9875
17
.github/ISSUE_TEMPLATE/bug_report.md
vendored
17
.github/ISSUE_TEMPLATE/bug_report.md
vendored
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
name: Bug report
|
name: Bug report
|
||||||
about: Create a bug report to help fix an issue with Whoogle
|
about: Create a bug report to help fix an issue with Whoogle
|
||||||
title: "[BUG] "
|
title: "[BUG] <brief bug description>"
|
||||||
labels: bug
|
labels: bug
|
||||||
assignees: ''
|
assignees: ''
|
||||||
|
|
||||||
|
@ -17,11 +17,18 @@ Steps to reproduce the behavior:
|
||||||
3. Scroll down to '....'
|
3. Scroll down to '....'
|
||||||
4. See error
|
4. See error
|
||||||
|
|
||||||
**Expected behavior**
|
**Deployment Method**
|
||||||
A clear and concise description of what you expected to happen.
|
- [ ] Heroku (one-click deploy)
|
||||||
|
- [ ] Docker
|
||||||
|
- [ ] `run` executable
|
||||||
|
- [ ] pip/pipx
|
||||||
|
- [ ] Other: [describe setup]
|
||||||
|
|
||||||
|
**Version of Whoogle Search**
|
||||||
|
- [ ] Latest build from [source] (i.e. GitHub, Docker Hub, pip, etc)
|
||||||
|
- [ ] Version [version number]
|
||||||
|
- [ ] Not sure
|
||||||
|
|
||||||
**Screenshots**
|
|
||||||
If applicable, add screenshots to help explain your problem.
|
|
||||||
|
|
||||||
**Desktop (please complete the following information):**
|
**Desktop (please complete the following information):**
|
||||||
- OS: [e.g. iOS]
|
- OS: [e.g. iOS]
|
||||||
|
|
2
.github/ISSUE_TEMPLATE/feature_request.md
vendored
2
.github/ISSUE_TEMPLATE/feature_request.md
vendored
|
@ -1,7 +1,7 @@
|
||||||
---
|
---
|
||||||
name: Feature request
|
name: Feature request
|
||||||
about: Suggest a feature that would improve Whoogle
|
about: Suggest a feature that would improve Whoogle
|
||||||
title: ''
|
title: "[FEATURE] <description of feature>"
|
||||||
labels: enhancement
|
labels: enhancement
|
||||||
assignees: ''
|
assignees: ''
|
||||||
|
|
||||||
|
|
|
@ -6,7 +6,7 @@ COPY requirements.txt .
|
||||||
RUN pip install --no-cache-dir -r requirements.txt
|
RUN pip install --no-cache-dir -r requirements.txt
|
||||||
|
|
||||||
ARG config_dir=/config
|
ARG config_dir=/config
|
||||||
RUN mkdir $config_dir
|
RUN mkdir -p $config_dir
|
||||||
VOLUME $config_dir
|
VOLUME $config_dir
|
||||||
ENV CONFIG_VOLUME=$config_dir
|
ENV CONFIG_VOLUME=$config_dir
|
||||||
|
|
||||||
|
|
27
README.md
27
README.md
|
@ -96,6 +96,33 @@ pip install -r requirements.txt
|
||||||
./run
|
./run
|
||||||
```
|
```
|
||||||
|
|
||||||
|
#### systemd Configuration
|
||||||
|
After building the virtual environment, you can add the following to `/lib/systemd/system/whoogle.service` to set up a Whoogle Search systemd service:
|
||||||
|
|
||||||
|
```
|
||||||
|
[Unit]
|
||||||
|
Description=Whoogle
|
||||||
|
|
||||||
|
[Service]
|
||||||
|
Type=simple
|
||||||
|
User=root
|
||||||
|
WorkingDirectory=<whoogle_directory>
|
||||||
|
ExecStart=<whoogle_directory>/venv/bin/python3 -um app --host 0.0.0.0 --port 5000
|
||||||
|
ExecReload=/bin/kill -HUP $MAINPID
|
||||||
|
Restart=always
|
||||||
|
RestartSec=3
|
||||||
|
SyslogIdentifier=whoogle
|
||||||
|
|
||||||
|
[Install]
|
||||||
|
WantedBy=multi-user.target
|
||||||
|
```
|
||||||
|
Then,
|
||||||
|
```
|
||||||
|
sudo systemctl daemon-reload
|
||||||
|
sudo systemctl enable whoogle
|
||||||
|
sudo systemctl start whoogle
|
||||||
|
```
|
||||||
|
|
||||||
### E) Manual (Docker)
|
### E) Manual (Docker)
|
||||||
1. Ensure the Docker daemon is running, and is accessible by your user account
|
1. Ensure the Docker daemon is running, and is accessible by your user account
|
||||||
- To add user permissions, you can execute `sudo usermod -aG docker yourusername`
|
- To add user permissions, you can execute `sudo usermod -aG docker yourusername`
|
||||||
|
|
Loading…
Reference in New Issue
Block a user