Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion docs/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,7 +18,6 @@ For non-core options (for example UI options), take a look at [Settings](https:/
| `APP_FORCE_HTTPS` | Force HTTPS on all URLs | `false` |
| `TRUSTED_PROXIES` | Trusted proxy IP addresses | `null` |
| `LOG_VIEWER_ENABLED` | Enable log viewer inside Lychee instead of through CLI. | `true` |
| `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` |
| `LEGACY_API_ENABLED` | Enable the Legacy API. It will also be enabled if `VUEJS_ENABLED` is set to `false`. | `false` |

> {note} `APP_URL` must only contain the hostname up to the Top Level Domain (tld) _e.g._ .com, .org etc.
Expand Down
6 changes: 5 additions & 1 deletion docs/contributions.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,14 +19,18 @@ Those are the versions in which we accept vulnerability reports.
|----------------|-----------|
| master | ✔ |
| latest release | ✔ |
| < 6.0 | &#10005; |
| < 7.0 | &#10005; |

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

## Core Development Discussion

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.

## Lychee Documentation

You will find a complete documentation in the original [repository](https://github.com/LycheeOrg/Lychee/tree/master/docs) under the `docs/` folder.

## Joining the Team

You would like to support Lychee and help us push it further? Join the team!
Expand Down
1 change: 1 addition & 0 deletions docs/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -458,6 +458,7 @@ For galleries with thousands of photos:
### FrankenPHP Benefits

The FrankenPHP-powered Version 7 image provides significant performance improvements over Version 6:

- **Faster boot times:** 4-6ms vs 40-60ms per request
- **Better throughput:** 3-4x improvement in requests per second
- **Lower latency:** Reduced response times across all operations
Expand Down
43 changes: 0 additions & 43 deletions docs/frontend.md

This file was deleted.

130 changes: 0 additions & 130 deletions docs/structure.md

This file was deleted.

21 changes: 15 additions & 6 deletions docs/upgrade.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,6 +42,10 @@ volumes:

> {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.

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.

**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."

### Service Architecture Changes

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

#### 7. **Run Migrations**
```bash
docker exec lychee php artisan migrate
```

#### 8. **Verify Installation**
#### 7. **Verify Installation**

Check that all services are running:
```bash
Expand All @@ -232,6 +231,16 @@ Check logs for errors:
docker-compose logs -f lychee
```

#### 8. **Fix the thumbnails**

You will notice that after the upgrade, thumbnails are missing. You can regenerate them by running:
```bash
docker exec -it lychee php artisan lychee:backfill-album-fields
```

or by logging into the web interface and going to Settings &rArr; Maintenance &rArr; Album Precomputed Fields.


### Troubleshooting

**Workers not processing jobs**
Expand Down
4 changes: 1 addition & 3 deletions gen.py
Original file line number Diff line number Diff line change
Expand Up @@ -63,8 +63,6 @@ def generate_base():
pages_title['contributions'] = 'Contribution Guide'
pages_title['api'] = 'API Documentation'
pages_title['architecture'] = 'Lychee logic overview'
pages_title['structure'] = 'Directory Structure'
pages_title['frontend'] = 'Front-end'

structure = [['Prologue',
['releases']]]
Expand All @@ -75,7 +73,7 @@ def generate_base():
structure += [['Frequently Asked Question',
['faq_general', 'faq_installation', 'faq_troubleshooting']]]
structure += [['Contributing',
['contributions', 'api', 'architecture', 'structure', 'frontend']]]
['contributions', 'api', 'architecture']]]


def gen_github_link(page):
Expand Down