aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorSquibid <me@zacharyscheiman.com>2023-09-22 23:06:35 -0400
committerSquibid <me@zacharyscheiman.com>2023-09-22 23:06:35 -0400
commit46d2d5cb819ca568935e75bee2332fdde64a1643 (patch)
treedcb87ded1826137c8a489a2157e165a69b73787d /README.md
parent2b1e75a2e5f374444cfeb9d252b26db2e0bb714f (diff)
downloadwallheaven-46d2d5cb819ca568935e75bee2332fdde64a1643.tar.gz
wallheaven-46d2d5cb819ca568935e75bee2332fdde64a1643.tar.bz2
wallheaven-46d2d5cb819ca568935e75bee2332fdde64a1643.zip
Add install instructions to README.md and add another TODO
Diffstat (limited to '')
-rw-r--r--README.md33
1 files changed, 30 insertions, 3 deletions
diff --git a/README.md b/README.md
index b8ae7e5..b079812 100644
--- a/README.md
+++ b/README.md
@@ -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