Skip to content

Commit 4894a49

Browse files
authored
feat(readme.md): move installation section from readme to its own specific directory (2)
1 parent 41f5a03 commit 4894a49

File tree

1 file changed

+1
-75
lines changed

1 file changed

+1
-75
lines changed

README.md

+1-75
Original file line numberDiff line numberDiff line change
@@ -42,81 +42,7 @@ Support the community. ❤️<br><br>
4242

4343
### How to host LibreY
4444

45-
To host LibreY using Docker, you can follow the instructions in the [Docker directory](https://github.com/Ahwxorg/LibreY/tree/main/docker).
46-
47-
To host LibreY using your OS's native package manager and PHP+NGINX, you can use the following steps as a guide.
48-
49-
These instructions are specific to Debian GNU/Linux but should be similar on most *nix variants (differences may include commands for package management, init system, php-fpm.sock location and availability of fastcgi-php.conf)
50-
51-
Install the packages (Debian GNU/Linux):
52-
53-
```sh
54-
apt install php php-fpm php-dom php-curl php-apcu nginx git
55-
```
56-
57-
Install the packages (Arch Linux):
58-
```sh
59-
pacman -S php php-fpm php-apcu nginx git
60-
```
61-
62-
Clone LibreY:
63-
64-
```sh
65-
mkdir -p /var/www/html
66-
git clone https://github.com/Ahwxorg/LibreY.git /var/www/html/LibreY
67-
```
68-
69-
Rename the config and opensearch files, edit manually if needed:
70-
71-
```sh
72-
cd /var/www/html/LibreY/
73-
mv config.php.example config.php
74-
mv opensearch.xml.example opensearch.xml
75-
```
76-
77-
Change opensearch.xml to point to your domain:
78-
79-
```sh
80-
sed -i 's/http:\/\/localhost:80/https:\/\/your.domain/g' opensearch.xml
81-
```
82-
83-
An nginx configuration similar to the one below should be placed in your `http { ... }` block or a file that is automatically detected as such.
84-
85-
```sh
86-
server {
87-
listen 80;
88-
89-
server_name your.domain;
90-
91-
root /var/www/html/LibreY;
92-
index index.php;
93-
94-
location ~ \.php$ {
95-
include snippets/fastcgi-php.conf;
96-
fastcgi_pass unix:/run/php/php-fpm.sock;
97-
}
98-
}
99-
```
100-
101-
You can optionally remove the .php extension in URLs by adding this code your `server { ... }` block.
102-
103-
```sh
104-
location / {
105-
try_files $uri $uri/ @extensionless-php;
106-
}
107-
108-
location @extensionless-php {
109-
rewrite ^(.*)$ $1.php last;
110-
}
111-
```
112-
113-
Start php-fpm and nginx immediately and on every boot:
114-
115-
```sh
116-
systemctl enable --now php-fpm nginx
117-
```
118-
119-
Now LibreY should be running at the port you specified!
45+
[This section has been moved](https://github.com/Ahwxorg/LibreY/tree/main/docs) to clear up some README space.
12046

12147
### About LibreY
12248

0 commit comments

Comments
 (0)