README.md

Backblaze Personal Wine Container

This Docker container runs the Backblaze personal backup client via WINE, so that you can back up your files with the separation and portability capabilities of Docker on Linux.

It runs the Backblaze client and starts a virtual X server and a VNC server with Web GUI, so that you can interact with it.

Table of Content

• Backblaze Personal Wine Container
  • Table of Content
  • Project Status
  • Docker Images
    • Content
    • Tags
    • Platforms
  • Environment Variables
  • Config Directory
  • Ports
  • Accessing the GUI
  • Security
    • SSVNC
    • Certificates
    • VNC Password
    • DH Parameters
  • Installation
  • Additional Information
  • Credits

Project Status

This project is pretty new, but i would consider it quite stable.

Backing up is tested well, Restoring is not tested very well so far.

Still please be attentive during the install process, because as the docker has read/write access to all the data you want to back up and if you make a grave mistake you could delete stuff.

Docker Images

Content

Here are the main components of this image:

• S6-overlay, a process supervisor for containers.
• x11vnc, a X11 VNC server.
• xvfb, a X virtual framebuffer display server.
• openbox, a windows manager.
• noVNC, a HTML5 VNC client.
• NGINX, a high-performance HTTP server.
• stunnel, a proxy encrypting arbitrary TCP connections with SSL/TLS.
• WINE, a compatibility layer for windows applications on Linux
• Winetricks is a helper script to download and install various redistributable runtime libraries needed to run some programs in Wine
• Backblaze Personal Backup

Tags

Tag	Description
latest	Latest stable version of the image based on ubuntu 20
ubuntu18	Latest stable version of the image based on ubuntu 18
v1.x	Versioned stable releases based on ubuntu 20
main	Automatic build of the main branch (may be unstable) based on ubuntu 20

There are currently no versioned ubuntu18 builds.

Platforms

Platform	Support
linux/amd64	Fully supported
linux/arm64	Currently no support (maybe in the future)
linux/arm/v7	No support
linux/arm/v6	No support
linux/riscv64	Currently no support (maybe in the future)
linux/s390x	No support
linux/ppc64le	No support
linux/386	No support

As Backblaze runs on Windows and MacOS, there is no point in supporting these platforms.

Environment Variables

Environment variables can be set by adding one or more arguments -e "<VAR>=<VALUE>" to the docker run command.

Variable	Description	Default
UMASK	Mask that controls how file permissions are set for newly created files. The value of the mask is in octal notation. By default, this variable is not set and the default umask of 022 is used, meaning that newly created files are readable by everyone, but only writable by the owner. See the following online umask calculator: http://wintelguy.com/umask-calc.pl	(unset)
TZ	[TimeZone] of the container. Timezone can also be set by mapping /etc/localtime between the host and the container.	Etc/UTC
APP_NICENESS	Priority at which the application should run. A niceness value of -20 is the highest priority and 19 is the lowest priority. By default, niceness is not set, meaning that the default niceness of 0 is used. NOTE: A negative niceness (priority increase) requires additional permissions. In this case, the container should be run with the docker option --cap-add=SYS_NICE.	(unset)
USER_ID	When mounting docker-volumes, permission issues can arise between the docker host and the container. You can pass the User_ID permissions to the container with this variable.	1000
GROUP_ID	When mounting docker-volumes, permission issues can arise between the docker host and the container. You can pass the Group_ID permissions to the container with this variable.	1000
CLEAN_TMP_DIR	When set to 1, all files in the /tmp directory are deleted during the container startup.	1
DISPLAY_WIDTH	Width (in pixels) of the virtual screen's window.	1280
DISPLAY_HEIGHT	Height (in pixels) of the virtual screen's window.	768
SECURE_CONNECTION	When set to 1, an encrypted connection is used to access the application's GUI (either via a web browser or VNC client). See the Security section for more details.	0
VNC_PASSWORD	Password needed to connect to the application's GUI. See the VNC Password section for more details.	(unset)
X11VNC_EXTRA_OPTS	Extra options to pass to the x11vnc server running in the Docker container. WARNING: For advanced users. Do not use unless you know what you are doing.	(unset)
ENABLE_CJK_FONT	When set to 1, open-source computer font WenQuanYi Zen Hei is installed. This font contains a large range of Chinese/Japanese/Korean characters.	0

Config Directory

Inside the container, wine's configuration and with it Backblaze's configuration is stored in the /config/wine/ directory.

This directory is also used to store the VNC password. See the VNC Pasword section for more details.

Ports

Here is the list of ports used by container. They can be mapped to the host via the -p <HOST_PORT>:<CONTAINER_PORT> parameter. The port number inside the container cannot be changed, but you are free to use any port on the host side.

Port	Mapping to host	Description
5800	Mandatory	Port used to access the application's GUI via the web interface.
5900	Optional	Port used to access the application's GUI via the VNC protocol. Optional if no VNC client is used.

Accessing the GUI

Assuming that container's ports are mapped to the same host's ports, the graphical interface of the application can be accessed via:

• A web browser:

http://<HOST IP ADDR>:5800

• Any VNC client:

<HOST IP ADDR>:5900

Security

By default, access to the application's GUI is done over an unencrypted connection (HTTP or VNC).

Secure connection can be enabled via the SECURE_CONNECTION environment variable. See the Environment Variables section for more details on how to set an environment variable.

When enabled, application's GUI is performed over an HTTPs connection when accessed with a browser. All HTTP accesses are automatically redirected to HTTPs.

When using a VNC client, the VNC connection is performed over SSL. Note that few VNC clients support this method. SSVNC is one of them.

SSVNC

SSVNC is a VNC viewer that adds encryption security to VNC connections.

While the Linux version of SSVNC works well, the Windows version has some issues. At the time of writing, the latest version 1.0.30 is not functional, as a connection fails with the following error:

ReadExact: Socket error while reading

However, for your convienence, an unoffical and working version is provided here:

https://github.com/jlesage/docker-baseimage-gui/raw/master/tools/ssvnc_windows_only-1.0.30-r1.zip

The only difference with the offical package is that the bundled version of stunnel has been upgraded to version 5.49, which fixes the connection problems.

Certificates

Here are the certificate files needed by the container. By default, when they are missing, self-signed certificates are generated and used. All files have PEM encoded, x509 certificates.

Container Path	Purpose	Content
/config/certs/vnc-server.pem	VNC connection encryption.	VNC server's private key and certificate, bundled with any root and intermediate certificates.
/config/certs/web-privkey.pem	HTTPs connection encryption.	Web server's private key.
/config/certs/web-fullchain.pem	HTTPs connection encryption.	Web server's certificate, bundled with any root and intermediate certificates.

NOTE: To prevent any certificate validity warnings/errors from the browser or VNC client, make sure to supply your own valid certificates.

NOTE: Certificate files are monitored and relevant daemons are automatically restarted when changes are detected.

VNC Password

To restrict access to your application, a password can be specified. This can be done via two methods:

• By using the VNC_PASSWORD environment variable.
• By creating a .vncpass_clear file at the root of the /config volume. This file should contains the password in clear-text. During the container startup, content of the file is obfuscated and moved to .vncpass.

The level of security provided by the VNC password depends on two things:

• The type of communication channel (encrypted/unencrypted).
• How secure access to the host is.

When using a VNC password, it is highly desirable to enable the secure connection to prevent sending the password in clear over an unencrypted channel.

Access to the host by unexpected users with sufficient privileges can be dangerous as they can retrieve the password with the following methods:

• By looking at the VNC_PASSWORD environment variable value via the docker inspect command. By defaut, the docker command can be run only by the root user. However, it is possible to configure the system to allow the docker command to be run by any users part of a specific group.
• By decrypting the /config/.vncpass file. This requires the user to have the appropriate permission to read the file: it has to be root or be the user defined by the USER_ID environment variable. Also, to be able to retrieve the correct decryption key, one needs to know that the content of the file was generated by x11vnc.

DH Parameters

Diffie-Hellman (DH) parameters define how the DH key-exchange is performed. More details about this algorithm can be found on the OpenSSL Wiki.

DH Parameters are saved into the PEM encoded file located inside the container at /config/certs/dhparam.pem. By default, when this file is missing, 2048 bits DH parameters are automatically generated. Note that this one-time operation takes some time to perform and increases the startup time of the container.

Installation:

1. Modify the following for your setup (in terms of ports and environment variables) and run it

   NOTE: root priviliges may be needed

   docker run \
       -p 8080:5800 \
       --init \
       --name backblaze_personal_backup \
       -v "[backup folder]/:/drive_d/" \
       -v "[config folder]/:/config/" \
       tessypowder/backblaze-personal-wine:latest

2. Open the Web Interface (on the port you specified in the docker run command, in this example 8080):

   

   

3. Click "Install" to install Mono

   

4. Wait for the Download to finish

   

5. Click "Install" to install Wine Gecko

   

6. Wait for the Download to finish

   

7. Click "Install" to install Wine Gecko (second dialog for Gecko)

8. Wait for the Download to finish

9. Add your storage path as a wine drive, so Backblaze can access it

   docker exec --user app backblaze_personal_backup ln -s /drive_d/ /config/wine/dosdevices/d:

10. Restart the docker to get Backblaze to recognize the new drive

    docker restart backblaze_personal_backup

11. Reload the Web Interface

    

12. The UI of the first step of the Backblaze installer is broken on wine, but it doesn't matter, just insert the email to your backblaze account into the input field

    

13. Press Enter

    

14. Insert your password (important: keyboard locale mismatches can mess up your inputs)

    • TIP: You can use the clipboard function of the web interface, but some passwords will still not get transferred correctly, i would reccommend setting your backblaze password to a long string without special characters

    

15. Press Enter

    

16. Wait for Backblaze to analyze your drives

    

17. Click Ok

    

18. If your [config folder] is somewehere inside the [backup folder] on the docker host side (which is the case for the Unraid template) in order to prevent an infinite loop of config file uploads, because those uploads change bz_done* files in [config folder]/wine/drive_c/ProgramData/Backblaze/bzdata/bzbackup/bzdatacenter open the web interface, open the Backblaze settings, open the "Exclusions" tab, click on "Add Folder" and in the popup navigate to My Computer -> (D:) and naviagate to the config folder inside. For unraid template installs this is My Computer -> (D:) -> appdata -> backblaze_personal_backup. Click on OK and close the Backblaze Settings.

19. The Installation is done 🎉

20. Buy a license for your Computer/Server in the Backblaze Dashboard, just like for a normal Windows/Mac installation

Troubleshooting

• The Backblaze Installer says it recognized a server operating system

  

  • Explanation: I don't know what can cause this, it seems to randomly occur on some installations

  • Solution: Stop the docker, delete the config directory, restart installation from beginning

  • (Speculation: I think this only happens, when no volume is mounted at /config/ and docker manages the folder instead of the volume)

• The backup folder mounted as drive D is not being backed up

  • Explanation: Depending on when you added drive D to your wine configuration, the Backblaze installer might not recognize it

  • Solution:

    • Open the Backblaze settings
    • In the section "Hard Drives" in the first tab "Settings" enable the checkbox for next to the drive D:\

  • Still not working:

    • Run

      docker exec --user app backblaze_personal_backup ls -la /config/wine/dosdevices/

    • The output should look like this:

        drwxr-xr-x 2 app app 4096 Jan 16 13:43 .
        drwxr-xr-x 4 app app 4096 Jan 16 14:08 ..
        lrwxrwxrwx 1 app app   10 Jan 16 13:43 c: -> ../drive_c
        lrwxrwxrwx 1 app app   10 Jan 16 13:43 d: -> /drive_d/
        lrwxrwxrwx 1 app app    1 Jan 16 13:43 z: -> /
      

    • If it doesn't look like above try step 9 - 10 again

• The Backblaze installer could not communicate with {URL} so installation failed. Fix your internet connection.

  

  • Explanation: The host device is a Synology Network Attached Storage, or has some sort of incompatibility with unbuntu20, which is the default.

  • Solution: Use the ubuntu18 tag instead

  • For More Information: See #4

Additional Information

1. Warning: The Backblaze client is not an init system (who knew) and doesn't clean up its zombie children. This will cause it to fill up your system's PID limit within a few hours which prevents new processes from being created system-wide, would not recommend.
   The --init flag installs a tiny process that can actually do a few init things like wait()ing children in place of the backblaze client as PID 1.
2. Backblaze will create a .bzvol directory in the root of every hard drive it's configured to back up in which it'll store a full copy of files >100M split into 10M parts. Mount accordingly if you want to preserve SSD erase cycles.
3. You can browse the files accessible to Backblaze using:

   docker exec --user app backblaze_personal_backup wine explorer

4. You can open the Wine Config using:

   docker exec --user app backblaze_personal_backup winecfg

5. The window size of Backblaze Personal Backup seems to be hardcoded, so it looks nicer (less black bars on the sides) when you set the size of the virtual VNC screen to the same size. The widest dialog the client opens is the recovery dialog with 657px and the tallest dialog are the settings with 453px. In order to fit the windows decorations i would suggest a screen size of 657x473. This can be set using environment variables when creating the docker:

   docker run ... -e "DISPLAY_WIDTH=657" -e "DISPLAY_HEIGHT=473" ...

Credits

This was originally developed by @Atemu (https://github.com/Atemu/backblaze-personal-wine-container).

The Backblaze name, logo and application is the property of Backblaze, Inc.

This docker does not redistribute the Backblaze application. It gets downloaded from the official Backblaze Servers during the install process.

This docker image is based on @jlesage 's excellent base image.

Contributors:

This project was made by: