mirror
/
photoview
mirror of https://github.com/photoview/photoview.git
1
Fork 0
Code

docs: Add reminder to url encode postgres password env variable (#1041)

This commit is contained in:
Amandus 2024-09-06 17:49:48 +02:00 committed by GitHub
parent 0ffa7e05fa
commit 8e602f8d2b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 4 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
README.md
View File

@ -99,6 +99,7 @@ All the photo galleries can do a lot of what I need, but no single one can do it
When downloading files, you need to choose only one of them.
2. Rename downloaded files and remove the `example` from their names (so, you need to have `.env`, `docker-compose.yml`, and `Makefile` files). If you choose the `docker-compose.minimal.example.yml` on previous step, make sure to rename it to the `docker-compose.yml`.
3. Open these files in a text editor and read them. Modify where needed according to the documentation comments to properly match your setup. There are comments of 2 types: those, starting with `##`, are explanations and examples, which should not be uncommented; those, starting with `#`, are optional or alternative configuration parts, which might be uncommented in certain circumstances, described in corresponding explanations. It is better to go through the files in the next order: `.env`, `docker-compose.yml`, and `Makefile`.
> If your `PGSQL_PASSWORD` or `MARIADB_PASSWORD` contain special characters (e.g. `@`), make sure to URL-encode them.
4. Make sure that your media library's root folder and all the files and subfolders are readable and searchable by other users: run the next command (or corresponding sequence of commands from the `Makefile`):
```bash
@ -293,6 +294,7 @@ You can install `node` with other package manager if you like.
- Comment the SQLite path variable
- Update `PHOTOVIEW_DATABASE_DRIVER` with your driver
- Uncomment the corresponding connection string variable for the new driver
> If your `PGSQL_PASSWORD` or `MARIADB_PASSWORD` contain special characters (e.g. `@`), make sure to URL-encode them.
- Optional: modify other variables if needed according to the inline comments
2. Rename `/ui/example.env` to `.env`

2
docker-compose example/example.env
View File

@ -36,6 +36,7 @@ PHOTOVIEW_DATABASE_DRIVER=mysql
## Use password generator to generate secret values and replace these defaults
MARIADB_DATABASE=photoview
MARIADB_USER=photoview
## Note: If your `MARIADB_PASSWORD` contains special characters (e.g. `@`), make sure to URL-encode them.
MARIADB_PASSWORD=photosecret
MARIADB_ROOT_PASSWORD=superphotosecret
##-----------------------------------##
@ -49,6 +50,7 @@ MARIADB_ROOT_PASSWORD=superphotosecret
## Uncomment the next lines if PHOTOVIEW_DATABASE_DRIVER is `postgres`
# PGSQL_DATABASE=photoview
# PGSQL_USER=photoview
## Note: If your `PGSQL_PASSWORD` contains special characters (e.g. `@`), make sure to URL-encode them.
# PGSQL_PASSWORD=superphotosecret
## See https://www.postgresql.org/docs/current/libpq-ssl.html for possible ssl modes
# PGSQL_SSL_MODE=prefer