aimacity/onedrive repository overview

⁠Docker OneDrive Sync

This Docker image powered by abraunegg/onedrive⁠ allows you to sync a local volume with OneDrive.

⁠Features:

• State caching
• File monitoring
• Resumable uploads
• Supports OneDrive for Business and OneDrive Personal

⁠Setup - First Run

When first launching the container you will need to authenticate with your Microsoft account. The procedure requires a web browser. You will be asked to open a specific link where you will have to login into your Microsoft Account and give the application the permission to access your files. After giving the permission, you will be redirected to a blank page. Copy the URI of the blank page into the application.

To allow you to copy the URI back into the docker container you need to launch it in interactive mode, this can be done using the -it flag.

mkdir  onedrive
cat > ./onedrive/config <<'EOF'
# Directory where the files will be synced
sync_dir = "/OneDrive"
# Skip files and directories that match this pattern
skip_file = "~*|.~*|*.tmp"
EOF
docker run -it \
  -e PUID=$(id -u) -e PGID=$(id -g) \
  -e TZ="Asia/Shanghai" \
  --restart always \
 --name onedrive \
  -v  ~/onedrive:/config \
  -v  ~/OneDrive:/OneDrive \
  aimacity/onedrive

Once authenticated you can stop the sync process and restart the container in non-interactive mode.

⁠Usage

docker run \
  -e PUID=<UID> -e PGID=<GID> \
  -e TZ=<timezone> \
  --restart always \
  -v </path/to/config>:/config \
  -v </path/to/documents>:/OneDrive \
  aimacity/onedrive

⁠Parameters

The parameters are split into two halves, separated by a colon, the left hand side representing the host and the right the container side.

• -v /config - This is where the OneDrive Client will store it's config. See abraunegg/onedrive#configuration⁠
• -v /OneDrive - This is the folder that will be synced with OneDrive
• -e TZ - for timezone information⁠ e.g. -e TZ=Europe/London
• -e PGID - for GroupID - This should match the GID of the user who owns the local files
• -e PUID - for UserID - This should match the UID of the user who owns the local files
• -e DEBUG=1 - to enable verbose logging set DEBUG=1

⁠Docker Compose

If you prefer to use Docker Compose⁠:

version: '2'
services:
  onedrive:
    image: aimacity/onedrive
    restart: always
    environment:
      - TZ=Asia/Shanghai
      - PGID=1000
      - PUID=1000
    volumes:
      - ./config:/config
      - ./OneDrive:/OneDrive

To authenticate with your Microsoft account for the first time run (this will start the container in interactive mode):

docker-compose run onedrive

You can then start the container in non-interactive and run it as a background process:

docker-compose up -d