github.com/tiredofit/docker-insync
About
This will build a Docker iamge for insync. A tool for backing up Google Drive.
- Supports Multiple accounts
Maintainer
Table of Contents
- About
- Maintainer
- Table of Contents
- Installation
- Configuration
- Maintenance
- Contributions
- Support
- License
- References
Installation
Build from Source
Clone this repository and build the image with docker build <arguments> (imagename) .
Prebuilt Images
Builds of the image are available on Docker Hub
docker pull docker.io/tiredofit/insync:(imagetag)
Builds of the image are also available on the Github Container Registry
docker pull ghcr.io/tiredofit/docker-insync:(imagetag)
The following image tags are available along with their tagged release based on what's written in the Changelog:
Version | Container OS | Tag |
---|---|---|
latest | Debian | :latest |
Multi Architecture
Images are built primarily for amd64
architecture, and may also include builds for arm/v7
, arm64
and others. These variants are all unsupported. Consider sponsoring my work so that I can work with various hardware. To see if this image supports multiple architecures, type docker manifest (image):(tag)
Configuration
Quick Start
-
The quickest way to get started is using docker-compose. See the examples folder for a working docker-compose.yml that can be modified for development or production use.
-
Set various environment variables to understand the capabilities of this image.
-
Map persistent storage for access to configuration and data files for backup.
- Make networking ports available for public access if necessary
Persistent Storage
The following directories are used for configuration and can be mapped for persistent storage.
Directory | Description |
---|---|
/data |
Backup and Configuration Directory |
/assets/custom-scripts |
Execute Custom Scripts before launching Insync - Drop .sh files here |
Environment Variables
Base Images used
This image relies on an Alpine Linux base image that relies on an init system for added capabilities. Outgoing SMTP capabilities are handlded via msmtp
. Individual container performance monitoring is performed by zabbix-agent. Additional tools include: bash
,curl
,less
,logrotate
,nano
.
Be sure to view the following repositories to understand all the customizable options:
Image | Description |
---|---|
OS Base | Customized Image based on Alpine Linux |
Parameter | Description | Default |
---|---|---|
INSYNC1_USERNAME |
Primary Your GDrive Username e.g. [email protected] |
|
INSYNC1_AUTH_CODE |
Primary Authorization Code provided by Google | |
INSYNC1_DOWNLOAD |
Primary How to download files link (.gdoc), ms-office (.docx), open-document (.odt) |
link |
INSYNC2_USERNAME |
Secondary Your GDrive Username e.g. [email protected] |
|
INSYNC2_AUTH_CODE |
Secondary Authorization Code provided by Google | |
INSYNC2_DOWNLOAD |
Secondary How to download files link (.gdoc), ms-office (.docx), open-document (.odt) |
link |
INSYNC3_USERNAME |
Third Your GDrive Username e.g. [email protected] |
|
INSYNC3_AUTH_CODE |
Third Authorization Code provided by Google | |
INSYNC3_DOWNLOAD |
Third How to download files link (.gdoc), ms-office (.docx), open-document (.odt) |
link |
PROXY_MODE |
Use Proxy TRUE or FALSE |
FALSE |
PROXY_TYPE |
Type of Proxy HTTP SOCKS4 SOCKS5 |
|
PROXY_HOST |
Name of Proxy Host e.g. proxy |
|
PROXY_PORT |
Port of Proxy e.g. 3128 |
|
PROXY_USER |
(Optional) Username for Proxy e.g. user |
|
PROXY_PASS |
(Optional) Password for Proxy e.g. password |
Networking
The following ports are exposed.
Port | Description |
---|---|
3306 |
insync Server |
Maintenance
Inside the image are tools to perform modification on how the image runs.
Selectively Syncing Files
- Enter the container and execute
manage_sync
and use the Ncurses Interface
Ignoring Files/Folders
- Enter the container and execute
manage_ignore
and use the Ncurses Interface
Shell Access
For debugging and maintenance purposes you may want access the containers shell.
docker exec -it (whatever your container name is) bash
Manual Backups can be perforemd by entering the container and typing backup-now
Contributions
Welcomed. Please fork the repository and submit a pull request for any bug fixes, features or additions you propose to be included in the image. If it does not impact my intended usage case, it will be merged into the tree, tagged as a release and credit to the contributor in the CHANGELOG.
Support
These images were built to serve a specific need in a production environment and gradually have had more functionality added based on requests from the community.
Usage
- The Discussions board is a great place for working with the community on tips and tricks of using this image.
- Consider sponsoring me for personalized support
Bugfixes
- Please, submit a Bug Report if something isn't working as expected. I'll do my best to issue a fix in short order.
Feature Requests
- Feel free to submit a feature request, however there is no guarantee that it will be added, or at what timeline.
- Consider sponsoring me regarding development of features.
Updates
- Best effort to track upstream changes, More priority if I am actively using the image in a production environment.
- Consider sponsoring me for up to date releases.
License
MIT. See LICENSE for more details.