Skip to content

Commit 36e084f

Browse files
authored
Update docs (#260)
1 parent 351fa58 commit 36e084f

File tree

7 files changed

+22
-184
lines changed

7 files changed

+22
-184
lines changed

docs/configuration.md

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,6 @@ For non-core options (for example UI options), take a look at [Settings](https:/
1818
| `APP_FORCE_HTTPS` | Force HTTPS on all URLs | `false` |
1919
| `TRUSTED_PROXIES` | Trusted proxy IP addresses | `null` |
2020
| `LOG_VIEWER_ENABLED` | Enable log viewer inside Lychee instead of through CLI. | `true` |
21-
| `VUEJS_ENABLED` | Enable v6 VueJs frontend; set to `false` if the new frontend doesn't work on our installation (this is a **temporary** workaround). | `true` |
2221
| `LEGACY_API_ENABLED` | Enable the Legacy API. It will also be enabled if `VUEJS_ENABLED` is set to `false`. | `false` |
2322

2423
> {note} `APP_URL` must only contain the hostname up to the Top Level Domain (tld) _e.g._ .com, .org etc.

docs/contributions.md

Lines changed: 5 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,14 +19,18 @@ Those are the versions in which we accept vulnerability reports.
1919
|----------------|-----------|
2020
| master | ✔ |
2121
| latest release | ✔ |
22-
| < 6.0 | &#10005; |
22+
| < 7.0 | &#10005; |
2323

2424
If you discover a security vulnerability within Lychee, please contact us directly on [Discord][2]. All security vulnerabilities will be promptly addressed.
2525

2626
## Core Development Discussion
2727

2828
You may propose new features or improvements to existing Lychee behavior in the [issue board][1]. If you propose a new feature, please be willing to implement at least some of the code that would be needed to complete the feature.
2929

30+
## Lychee Documentation
31+
32+
You will find a complete documentation in the original [repository](https://github.com/LycheeOrg/Lychee/tree/master/docs) under the `docs/` folder.
33+
3034
## Joining the Team
3135

3236
You would like to support Lychee and help us push it further? Join the team!

docs/docker.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -458,6 +458,7 @@ For galleries with thousands of photos:
458458
### FrankenPHP Benefits
459459

460460
The FrankenPHP-powered Version 7 image provides significant performance improvements over Version 6:
461+
461462
- **Faster boot times:** 4-6ms vs 40-60ms per request
462463
- **Better throughput:** 3-4x improvement in requests per second
463464
- **Lower latency:** Reduced response times across all operations

docs/frontend.md

Lines changed: 0 additions & 43 deletions
This file was deleted.

docs/structure.md

Lines changed: 0 additions & 130 deletions
This file was deleted.

docs/upgrade.md

Lines changed: 15 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -42,6 +42,10 @@ volumes:
4242
4343
> {note} Notice the key changes: uploads are now at `/app/public/uploads`, storage at `/app/storage/app`, tmp at `/app/storage/tmp`, and the `.env` file is mounted read-only.
4444

45+
The `/sym` volume has been removed as Lychee no longer uses symbolic links for storage. This was a security feature that originated from version 4, but is no longer necessary as the functionality has been removed.
46+
47+
**Important:** With the 3 volumes under `/app/storage`, you may think you could simplify the configuration by specifying one single volume for `/app/storage` instead. This is incorrect. Doing so will make the app exit with the error "The `/app/bootstrap/cache` directory must be present and writable."
48+
4549
### Service Architecture Changes
4650

4751
Version 7 introduces a multi-service architecture with an optional worker service for background job processing.
@@ -215,12 +219,7 @@ Key changes to your environment configuration:
215219
docker-compose up -d
216220
```
217221

218-
#### 7. **Run Migrations**
219-
```bash
220-
docker exec lychee php artisan migrate
221-
```
222-
223-
#### 8. **Verify Installation**
222+
#### 7. **Verify Installation**
224223

225224
Check that all services are running:
226225
```bash
@@ -232,6 +231,16 @@ Check logs for errors:
232231
docker-compose logs -f lychee
233232
```
234233

234+
#### 8. **Fix the thumbnails**
235+
236+
You will notice that after the upgrade, thumbnails are missing. You can regenerate them by running:
237+
```bash
238+
docker exec -it lychee php artisan lychee:backfill-album-fields
239+
```
240+
241+
or by logging into the web interface and going to Settings &rArr; Maintenance &rArr; Album Precomputed Fields.
242+
243+
235244
### Troubleshooting
236245

237246
**Workers not processing jobs**

gen.py

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -63,8 +63,6 @@ def generate_base():
6363
pages_title['contributions'] = 'Contribution Guide'
6464
pages_title['api'] = 'API Documentation'
6565
pages_title['architecture'] = 'Lychee logic overview'
66-
pages_title['structure'] = 'Directory Structure'
67-
pages_title['frontend'] = 'Front-end'
6866

6967
structure = [['Prologue',
7068
['releases']]]
@@ -75,7 +73,7 @@ def generate_base():
7573
structure += [['Frequently Asked Question',
7674
['faq_general', 'faq_installation', 'faq_troubleshooting']]]
7775
structure += [['Contributing',
78-
['contributions', 'api', 'architecture', 'structure', 'frontend']]]
76+
['contributions', 'api', 'architecture']]]
7977

8078

8179
def gen_github_link(page):

0 commit comments

Comments
 (0)