abraunegg-onedrive/docs/Docker.md

onedrive docker image

Thats right folks onedrive is now dockerized ;)

This container offers simple monitoring-mode service for 'Free Client for OneDrive on Linux'.

Basic Setup

0. Install docker under your own platform's instructions

1. Pull the image

docker pull driveone/onedrive:latest

NOTE: SELinux context needs to be configured or disabled for Docker, to be able to write to OneDrive host directory.

2. Prepare config volume

Onedrive needs two volumes. One of them is the config volume. Create it with:

docker volume create onedrive_conf

This will create a docker volume labeled onedrive_conf, where all configuration of your onedrive account will be stored. You can add a custom config file and other things later.

The second docker volume is for your data folder and is created in the next step. It needs the path to a folder on your filesystem that you want to keep in sync with OneDrive. Keep in mind that:

• The owner of your specified folder must not be root

• The owner of your specified folder must have permissions for its parent directory

3. First run

Onedrive needs to be authorized with your Microsoft account. This is achieved by running docker in interactive mode. Run the docker image with the two commands below and make sure to change onedriveDir to the onedrive data directory on your filesystem (e.g. "/home/abraunegg/OneDrive"). Additionally, the user id and group id should be added to remove any potential user conflicts, denoted by the environment variables ${ONEDRIVE_UID} and ${ONEDRIVE_GID}.

onedriveDir="${HOME}/OneDrive"
docker run -it --name onedrive -v onedrive_conf:/onedrive/conf -v "${onedriveDir}:/onedrive/data" -e "ONEDRIVE_UID:${ONEDRIVE_UID}" -e "ONEDRIVE_GID:${ONEDRIVE_GID}" driveone/onedrive:latest

• You will be asked to open a specific link using your web browser
• Login to your Microsoft Account and give the application the permission
• After giving the permission, you will be redirected to a blank page.
• Copy the URI of the blank page into the application.

The onedrive monitor is configured to start with your host system. If your onedrive is working as expected, you can detach from the container with Ctrl+p, Ctrl+q.

4. Status, stop, and restart

Check if the monitor service is running

docker ps -f name=onedrive

Show monitor run logs

docker logs onedrive

Stop running monitor

docker stop onedrive

Resume monitor

docker start onedrive

Remove onedrive monitor

docker rm -f onedrive

Advanced Setup

5. Docker-compose

Also supports docker-compose schemas > 3. In the following example it is assumed you have a onedriveDir environment variable and a onedrive_conf volume. However, you can also use bind mounts for the configuration folder, e.g. export ONEDRIVE_CONF="${HOME}/OneDriveConfig".

version: "3"
services:
    onedrive:
        image: driveone/onedrive:latest
        restart: unless-stopped
        environment:
            - ONEDRIVE_UID=${PUID}
            - ONEDRIVE_GID=${PGID}
        volumes: 
            - onedrive_conf:/onedrive/conf
            - ${onedriveDir}:/onedrive/data

Note that you still have to perform step 3: First Run.

6. Edit the config

Onedrive should run in default configuration, however you can change your configuration by placing a custom config file in the onedrive_conf docker volume. First download the default config from here
Then put it into your onedrive_conf volume path, which can be found with:

docker volume inspect onedrive_conf

Or you can map your own config folder to the config volume. Make sure to copy all files from the docker volume into your mapped folder first.

The detailed document for the config can be found here: additional-configuration

7. Sync multiple accounts

There are many ways to do this, the easiest is probably to

1. Create a second docker config volume (replace Work with your desired name): docker volume create onedrive_conf_Work
2. And start a second docker monitor container (again replace Work with your desired name):

onedriveDirWork="/home/abraunegg/OneDriveWork"
docker run -it --restart unless-stopped --name onedrive_Work -v onedrive_conf_Work:/onedrive/conf -v "${onedriveDirWork}:/onedrive/data" driveone/onedrive:latest

Run or update with one script

If you are experienced with docker and onedrive, you can use the following script:

# Update onedriveDir with correct existing OneDrive directory path
onedriveDir="${HOME}/OneDrive"

firstRun='-d'
docker pull driveone/onedrive:latest
docker inspect onedrive_conf > /dev/null || { docker volume create onedrive_conf; firstRun='-it'; }
docker inspect onedrive > /dev/null && docker rm -f onedrive
docker run $firstRun --restart unless-stopped --name onedrive -v onedrive_conf:/onedrive/conf -v "${onedriveDir}:/onedrive/data" driveone/onedrive:latest

Environment Variables

Variable	Purpose	Sample Value
ONEDRIVE_UID	UserID (UID) to run as	1000
ONEDRIVE_GID	GroupID (GID) to run as	1000
ONEDRIVE_VERBOSE	Controls "--verbose" switch on onedrive sync. Default is 0	1
ONEDRIVE_DEBUG	Controls "--verbose --verbose" switch on onedrive sync. Default is 0	1
ONEDRIVE_DEBUG_HTTPS	Controls "--debug-https" switch on onedrive sync. Default is 0	1
ONEDRIVE_RESYNC	Controls "--resync" switch on onedrive sync. Default is 0	1

Usage Examples

Verbose Output:

docker container run -e ONEDRIVE_VERBOSE=1 -v onedrive_conf:/onedrive/conf -v "${onedriveDir}:/onedrive/data" driveone/onedrive:latest

Debug Output:

docker container run -e ONEDRIVE_DEBUG=1 -v onedrive_conf:/onedrive/conf -v "${onedriveDir}:/onedrive/data" driveone/onedrive:latest

Perform a --resync:

docker container run -e ONEDRIVE_RESYNC=1 -v onedrive_conf:/onedrive/conf -v "${onedriveDir}:/onedrive/data" driveone/onedrive:latest

Perform a --resync and --verbose:

docker container run -e ONEDRIVE_RESYNC=1 -e ONEDRIVE_VERBOSE=1 -v onedrive_conf:/onedrive/conf -v "${onedriveDir}:/onedrive/data" driveone/onedrive:latest

Build instructions

Build Environment Requirements

• Build environment must have at least 1GB of memory & 2GB swap space

There are 2 ways to validate this requirement:

• Modify the file /etc/dphys-swapfile and edit the CONF_SWAPSIZE, for example: CONF_SWAPSIZE=2024. A reboot is required to make this change effective.
• Dynamically allocate a swapfile for building:

cd /var 
sudo fallocate -l 1.5G swapfile
sudo chmod 600 swapfile
sudo mkswap swapfile
sudo swapon swapfile
# make swap permanent
sudo nano /etc/fstab
# add "/swapfile swap swap defaults 0 0" at the end of file
# check it has been assigned
swapon -s
free -h

Building the Docker image

You can also build your own image instead of pulling the one from dockerhub:

git clone https://github.com/abraunegg/onedrive
cd onedrive
docker build . -t local-onedrive -f contrib/docker/Dockerfile

There are alternate, smaller images available by building Dockerfile-stretch or Dockerfile-alpine. These multi-stage builder pattern Dockerfiles require Docker version at least 17.05.

docker build . -t local-ondrive-stretch -f contrib/docker/Dockerfile-stretch

or

docker build . -t local-ondrive-alpine -f contrib/docker/Dockerfile-alpine