Edit readme
This commit is contained in:
parent
d27c20e041
commit
b768084b23
34
README.md
34
README.md
|
@ -1,7 +1,5 @@
|
|||
# PhotoView
|
||||
|
||||
**SERVER REWRITE. The api is currently being rewritten in Golang, use branch `old-nodejs-server` for the most stable release**
|
||||
|
||||
![screenshot](./screenshots/main-window.png)
|
||||
|
||||
## Demo site
|
||||
|
@ -16,14 +14,40 @@ Password: **demo**
|
|||
The aim of this project is to make a simple and user-friendly photo gallery application,
|
||||
that is easy to host on a personal server, to easily view the photos located on that server.
|
||||
|
||||
## Main features
|
||||
## Why yet another self-hosted photo gallery
|
||||
|
||||
> The software is still in early development, and many of the following features, may not have been fully implemented yet.
|
||||
There exists a lot of open-source self-hosted photo galleries already. Here are some, just to mention a few.
|
||||
|
||||
- [Piwigo](https://github.com/Piwigo/Piwigo)
|
||||
- [Ownphoto](https://github.com/hooram/ownphotos)
|
||||
- [Photoprism](https://github.com/photoprism/photoprism)
|
||||
- [Photato](https://github.com/trebonius0/Photato)
|
||||
|
||||
So why another one?
|
||||
I love taking photos, and I store all of them on my local fileserver.
|
||||
This is great because I can organize my photos directly on the filesystem so it's easy to move them or take backups. I want to be able to control where and how the photos are stored.
|
||||
|
||||
The problem is however that RAW images are extremely tedious to navigate from a fileserver, even over the local network.
|
||||
|
||||
My server holds a lot of old family pictures, that I would like my family to have access to as well.
|
||||
And some of the pictures I would like to easily be able to share with other people without the hassle of them having to make an account first.
|
||||
|
||||
Thus I need a solution that can do the following:
|
||||
|
||||
- A scan based approach that automatically organises my photos
|
||||
- Support RAW and EXIF parsing
|
||||
- Have support for multiple users and ways to share albums and photos also publicly
|
||||
- Be simple and fast to use
|
||||
|
||||
All of the photo galleries can do a lot of what I need, but no single one can do it all.
|
||||
|
||||
## Main features
|
||||
|
||||
- **Closely tied to the file system**. The website presents the images found on the local filesystem of the server, directories are mapped to albums.
|
||||
- **User management**. Each user is created along with a path on the local filesystem, photos within that path can be accessed by that user.
|
||||
- **Photo sharing**. Photos and albums can easily be shared with other users or publicly with a unique URL.
|
||||
- **Made for photography**. The website is ment as a way to present photographies, and thus supports **RAW** file formats, and **EXIF** parsing.
|
||||
- **Performant**. Thumbnails are automatically generated and photos first load when they are visible on the screen. In full screen, thumbnails are displayed until the high resolution image has been fully loaded.
|
||||
|
||||
## Getting started - Setup with Docker
|
||||
|
||||
|
@ -38,7 +62,7 @@ $ cd photoview
|
|||
```
|
||||
|
||||
2. Duplicate `docker-compose.example.yml` and name the new file `docker-compose.yml`
|
||||
3. Edit `docker-compose.yml`, find the comments starting with `Change This:`, and change the values, to properly match your setup.
|
||||
3. Edit `docker-compose.yml`, find the comments starting with `Change This:`, and change the values, to properly match your setup. If you are just testing locally, you don't have to change anything.
|
||||
4. Start the server by running the following command, inside the `photoview` directory
|
||||
|
||||
```bash
|
||||
|
|
Loading…
Reference in New Issue