Improved installation instructions

This commit is contained in:
Michael Mayer 2018-10-08 22:09:13 +02:00
parent 0eafaca29c
commit 9568a3d190

View file

@ -46,12 +46,12 @@ Developers can skip this and move on to the [Developer Guide](https://github.com
By default, a folder named `Photos` in your home directory will be used to store all images. You don't need to create it. By default, a folder named `Photos` in your home directory will be used to store all images. You don't need to create it.
PhotoPrism will also create the following sub-directories in your photo path: `Import`, `Export` and `Originals`. Copy existing photos to `Import`, not directly to `Originals` as they need to be renamed and indexed in order to remove duplicates. PhotoPrism will also create the following sub-directories in your `Photos` folder: `Import`, `Export` and `Originals`. Copy existing photos to `Import`, not directly to `Originals` as they need to be renamed and indexed in order to remove duplicates.
Files that can not be imported - like videos - will stay in the `Import` directory, nothing gets lost. Files that can not be imported - like videos - will stay in the `Import` directory, nothing gets lost.
If you prefer to use different directory names, you can change them in `docker-compose.yml`. See inline comments for instructions. If you prefer to use different directory names, you can change them in `docker-compose.yml`. See inline comments for instructions.
**Step 2:** Start PhotoPrism using `docker-compose` in the same directory: **Step 2:** Open a terminal, go to the directory in which you saved the config file and run this command to start the application:
```bash ```bash
docker-compose up -d docker-compose up -d
@ -59,7 +59,7 @@ docker-compose up -d
The Web frontend is now available at http://localhost:2342/. The port can be changed in `docker-compose.yml` if needed. Remember to run `docker-compose restart` every time you change the config. The Web frontend is now available at http://localhost:2342/. The port can be changed in `docker-compose.yml` if needed. Remember to run `docker-compose restart` every time you change the config.
**Step 3:** Open a terminal to import photos: **Step 3:** Connect to the application container and run `photoprism import` after putting files in the `Import` folder:
```bash ```bash
docker-compose exec photoprism bash docker-compose exec photoprism bash