Add install instructions to README.md and add another TODO

This commit is contained in:
2023-09-22 23:06:35 -04:00
parent 2b1e75a2e5
commit 46d2d5cb81

View File

@ -1,6 +1,6 @@
# WallHeaven
The best wallpaper proxy
Might be endorsed by the pope, idk
The best wallpaper proxy.
Might be endorsed by the pope!
## Instances
| Name | Link |
@ -8,10 +8,37 @@ Might be endorsed by the pope, idk
| Squibid's instance (master) in the US | [wallheaven.squi.bid](https://wallheaven.squi.bid) |
## Install Instructions
coming soon™
### Nginx
1. git clone this repo into a path accessable by the user running nginx
2. put the config below into your /etc/nginx/sites-available
3. `ln -s /etc/nginx/sites-available/wallheaven /etc/nginx/sites-enabled/`
4. run `certbot --nginx` (make sure you have the nginx module installed)
5. restart the nginx service
```
server {
server_name example.com;
root /path/to/dir;
index index.php;
location ~ \.php$ {
include snippets/fastcgi-php.conf;
fastcgi_pass unix:/run/php/php7.3-fpm.sock;
}
}
server {
listen 80;
server_name example.com;
}
```
#### Additional Notes
You will need to install fastcgi and php in order to run wallheaven
along with certbot and the required nginx module to get a SSL cert.
Good luck, and thanks for hosting an instance :).
## ToDo
- add a website icon
- make image embed better when sharing
## Known Bug(s) (I'm too lazy to fix these)
- Tags occasionally overflow onto the next line if hovered over