Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/rfgamaral/docker-gphotos-uploader

🐳 Mass upload media folders to your Google Photos account with this Docker image.
https://github.com/rfgamaral/docker-gphotos-uploader

docker docker-image google google-photos google-photos-albums google-photos-backup google-photos-cli

Last synced: about 2 months ago
JSON representation

🐳 Mass upload media folders to your Google Photos account with this Docker image.

Host: GitHub
URL: https://github.com/rfgamaral/docker-gphotos-uploader
Owner: rfgamaral
License: mit
Created: 2019-02-02T11:21:15.000Z (over 5 years ago)
Default Branch: master
Last Pushed: 2020-04-12T18:57:19.000Z (over 4 years ago)
Last Synced: 2024-04-17T00:19:13.371Z (5 months ago)
Topics: docker, docker-image, google, google-photos, google-photos-albums, google-photos-backup, google-photos-cli
Language: JavaScript
Homepage:
Size: 81.1 KB
Stars: 56
Watchers: 6
Forks: 12
Open Issues: 5
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

README

# rfgamaral/gphotos-uploader

![ci workflow](https://github.com/rfgamaral/docker-gphotos-uploader/workflows/Docker%20Images%20CI/badge.svg)
![image size](https://img.shields.io/microbadger/image-size/rfgamaral/gphotos-uploader.svg)
![layers](https://img.shields.io/microbadger/layers/rfgamaral/gphotos-uploader.svg)
![docker pulls](https://img.shields.io/docker/pulls/rfgamaral/gphotos-uploader.svg)
![docker Stars](https://img.shields.io/docker/stars/rfgamaral/gphotos-uploader.svg)

This repository contains the _Dockerfiles_ and all other files needed to create and run a container with a background task to mass upload media folders to your [Google Photos](https://photos.google.com) account. The task runs periodically on a predefined schedule and is powered by [`gphotos-uploader-cli`](https://github.com/nmrshll/gphotos-uploader-cli).

## Supported Architectures

This image supports multiple architectures such as `x86-64`, `arm64` and `armhf`. Simply pulling `rfgamaral/gphotos-uploader` should retrieve the correct image for your architecture, but you can always pull specific architecture images via tags.

The architectures supported by this image are:

| Architecture | Tag (`latest`) | Tag (`x.y.z`) | Tag (`preview`) |
| :----: | --- | --- | --- |
| x86-64 | `amd64-latest` | `amd64-x.y.z` | `amd64-preview` |
| arm64 | `arm64v8-latest` | `arm64v8-x.y.z` | `arm64v8-preview` |
| armhf | `arm32v7-latest` | `arm32v7-x.y.z` | `arm32v7-preview` |

## Usage

### Create and start the container

Make sure the Docker daemon is running and then start the container like this:

```
docker run -d \
--name=gphotos-uploader \
-e GPU_SCHEDULE="" \
-p :29070 \
-v :/config \
-v :/photos \
--restart unless-stopped \
rfgamaral/gphotos-uploader
```

Once the container is running and before `gphotos-uploader-cli` is able to work properly, you'll first need to edit the `/config/config.hsjon` and set your `APIAppCredentials` according to the [Authentication](#authentication) section below. Please refer to the official [documentation](https://github.com/nmrshll/gphotos-uploader-cli/blob/master/.docs/configuration.md) for all other configuration options.

### Container configuration parameters

Please refer to the following table for all available configuration paramaters that can be passed at run-time to container images:

| Parameter | Required | Description |
| :----: | --- | --- |
| `-e GPU_SCHEDULE=""` | | Background task schedule expression (defaults to every 8 hours).
See [crontab.guru](https://crontab.guru/) for help with the schedule expression. |
| `-p :29070` |

✔

| Publish the container's `29070` internal port to the host as ``.
This is necessary for the Authentication process (more on that below). |
| `-v :/config` |

✔

| Absolute host path to store `gphotos-uploader-cli` configuration. |
| `-v :/photos` |

✔

| Absolute host path for the photos library source folder. |

## Authentication

Given that `gphotos-uploader-cli` uses OAuth 2 to access Google APIs, authentication is a bit tricky and involves a few manual steps. Please follow the guide below carefully, to give `gphotos-uploader-cli` the required access to your Google Photos account.

### API credentials

Before you can use `gphotos-uploader-cli`, you must enable the Photos Library API and request an OAuth 2.0 Client ID.

1. Make sure you're logged in into the Google Account where your photos should be uploaded to.
2. Start by [creating a new project](https://console.cloud.google.com/projectcreate) in Google Cloud Platform and give it a name (e.g., _Google Photos Uploader_).
3. Enable the [Google Photos Library API](https://console.cloud.google.com/apis/library/photoslibrary.googleapis.com) by clicking the ENABLE button.
4. Configure the [OAuth consent screen](https://console.cloud.google.com/apis/credentials/consent) by setting the application name (e.g., _docker-gphotos-uploader_) and then click the Save button on the bottom.
5. Create [credentials](https://console.cloud.google.com/apis/credentials) by clicking the **Create credentials → OAuth client ID** option, then pick **Other** as the application type and give it a name (e.g., _gphotos-uploader-cli_).
6. Copy the **Client ID** and the **Client Secret** and keep them ready to use in the next section.

### CLI authentication

Once an OAuth 2.0 Client ID is generated, authenticating `gphotos-uploader-cli` against your Google Account is required for proper access to your Google Photos account.

_The following steps assume the container has been created and it's running. If not, please refer to the [create and start the container](#create-and-start-the-container) section above before continuing._

1. Open the `/config/config.hsjon` file and set both the `ClientID` and `ClientSecret` options to the ones generated in the previous section and your the `jobs[0].account` option to the Google Account e-mail address where your photos should be uploaded to.
2. Open your favorite terminal and run the following command to start the authentication process:

```
docker exec -it gphotos-uploader run
```

3. You should get an output similar to this one:

```
[info] Opening browser to complete authorization.
[warn] Browser was not detected. Complete the authorization browsing to: http://localhost:29070
```

Open the authorization URL in your main browser and allow **docker-gphotos-uploader** access to your Google Account to "View and manage your Google Photos library". Please note that you'll have to replace `localhost` with the Docker host network IP address if accessing from a different machine in your local network.

4. Once the authentication process is complete you should get a green box with "Success!".

The authentication process is now complete and `gphotos-uploader-cli` is ready to upload your photos on the background.

## Support Information

### Force run `gphotos-uploader-cli` upload task:

```
docker exec -it gphotos-uploader run
```

### Shell access whilst the container is running:

```
docker exec -it gphotos-uploader /bin/sh
```

### To monitor the logs of the container in real-time:

```
docker logs -f gphotos-uploader
```

## License

The use of this source code is governed by an MIT-style license that can be found in the [LICENSE](LICENSE) file.