Skip to content

Commit

Permalink
some minor adjustments to comply with the latest released docker image
Browse files Browse the repository at this point in the history
  • Loading branch information
thebino committed Jul 15, 2023
1 parent 871aeb2 commit 68f1825
Show file tree
Hide file tree
Showing 6 changed files with 16 additions and 60 deletions.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,8 @@
[![Discord](https://img.shields.io/discord/793235453871390720)](https://discord.gg/dGFDpmWp46)


[Photos.network](https://photos.network) is an open source project for self hosted photo management.
[Photos.network](https://photos.network) is a privacy first, self-hosted photo storage and sharing service.

Its core features are:
- Share photos with friends, family or public
- Filter / Search photos by attributes like location or date
Expand Down
37 changes: 3 additions & 34 deletions docs/documentation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,6 @@
{
"internal_url": "192.168.0.1",
"external_url": "photos.external.com",
"data_dir": "data",
"clients": [
{
"name": "Frontend",
Expand Down Expand Up @@ -38,7 +37,6 @@
| ------------------- | ------------------------------------ |
| `internal_url` | Indicates the internal network address. |
| `external_url` | The external network address e.g.: used to create links for sharing. |
| `data_dir` | Path where all the data will be stored. |
| `clients` | List of clients e.g. Web frontend or Android. |
| `addons` | List of addons and their custom configurations. |

Expand All @@ -47,27 +45,12 @@
#### Minimal configuration
```json
{
"frontend_url": "http://172.20.0.2",
"frontend_port": 7778,
"core_url": "http://127.0.0.1",
"core_port": 7777,
"client_id": "",
"client_secret": "",
"redirect_uri": "http://127.0.0.1:7778/callback"
"internal_url": "192.168.0.1",
"external_url": "photos.external.com",

}
```

| Properties | Description |
| ------------------- | --------------------------------------------- |
| `frontend_url` | Indicates the internal network address. |
| `frontend_port` | Indicates the internal network port. |
| `core_url` | Communication address for the core system. |
| `core_port` | Communication port for the core system. |
| `client_id` | Client credentials to get access to the core. |
| `client_secret` | Client secret to get access to the core. |
| `redirect_uri` | Redirect address for callbacks from the core. |


## Nginx

It is recommended to run **photos.network** behind a reverse proxy like nginx or HAProxy.
Expand Down Expand Up @@ -119,17 +102,3 @@ server {
}
```

Running the **frontend** and **core** behind a reverse proxy could look like this:

```json
{
"frontend_url": "https://photos.example.com",
"frontend_port": 7778,
"core_url": "https://photos.example.com",
"core_port": 443,
"client_id": "",
"client_secret": "",
"redirect_uri": "https://photos.example.com/callback"
}
```
12 changes: 6 additions & 6 deletions docs/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,19 +5,19 @@ hide:
---
# Photos.network

Photos.network is an open source project for self hosted photo management.
Photos.network is a self-hosted, privacy first photo storage and sharing service.
Its core features are:

* Keep track of your photos with privacy
* Share photos and albums with friends, family or with public
* Search for photos by attributes like location or objects
* Search for photos by attributes like location, objects or people

Must applications for photo management are hosted in the cloud by big companies like Google, Apple or Amazon.
This application can also be hosted in the cloud, but **you can manage the access rights**.
Most applications for photo management are hosted in the cloud by big companies like Google, Apple or Amazon.
This application can also be hosted in the cloud, but **you are in control of all access rights**.


!!!warning
This application is in development and not available for endusers yet!
This application is still in development and does not support all features!


If you want to contribute the development: **[developers.photos.network](https://developers.photos.network/)**
Expand All @@ -26,4 +26,4 @@ This application can also be hosted in the cloud, but **you can manage the acces


![Showcase](/demo_responsive.jpg){: loading=lazy, align=right }
Use Photos.network in a browser or a mobile device.
Use Photos.network in a browser or on a mobile device.
18 changes: 2 additions & 16 deletions docs/installation/docker.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ hide:
This guide will help you to get Photos.network up and running in an docker environment.

!!!warning
Early preview! This is an early preview of the core system and the frontend!
Early preview! This is an early preview of the core system!



Expand All @@ -18,28 +18,14 @@ version: "3"

services:
core:
image: photosnetwork/core:0.5.0
image: photosnetwork/core:0.5.2
# expose container port to host system
ports:
- "7777:7777"

# expose port to linked service
expose: ["7777"]

volumes:
- /share/photos.network/config:/app/config:rw
- /share/photos.network/data:/app/data:rw

web:
image: photosnetwork/frontend:0.2.0

# expose container port to host system
ports:
- "7778:7778"

# expose port to linked service
expose: ["7778"]

volumes:
- /share/photos.network/config:/app/config:rw
- /share/photos.network/data:/app/data:rw
Expand Down
2 changes: 1 addition & 1 deletion docs/installation/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ This guide will help you to get Photos.network up and running in your local envi

It is recommended to use at least the following hardware to get a smooth experience:

- [Raspberry Pi 4](https://www.raspberrypi.org/products/)
- [Raspberry Pi 2](https://www.raspberrypi.org/products/)

## Installation

Expand Down
4 changes: 2 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -18,8 +18,8 @@ extra:
social:
- icon: fontawesome/brands/docker
link: https://hub.docker.com/r/photosnetwork
- icon: fontawesome/brands/twitter
link: https://twitter.com/photosnetwork
- icon: fontawesome/brands/mastodon
link: https://mastodon.cloud/@photos

markdown_extensions:
- pymdownx.highlight:
Expand Down

0 comments on commit 68f1825

Please sign in to comment.