Tutorial: WPS-Office on Synology

[Fox Mulder]

Hello everyone!

 

Another day, another tutorial.

This one is a office suite (well, a basic one) working off your synology server. No more need for a Office 365 subscription, and with the ability to password protect both access and documents, it's easy enough to open it up to the internet and use it from anywhere!

I actually tried several office docker installations, and found each one having one issue or another. Sure, libreoffice, or onlyoffice may look better or offer more features, but they simply don't seem to work that well on synology. I have tried and ground my teeth on those so you don't have to. (although, if you have a good tutorial/advice, I am open to read about it)

 

Okay, so this tutorial is really simple.

1. First, you need portainer. You can install this from terminal, sure, but managing and updating from portainer is much easier in my eyes.
2. I won't give you a portainer installation tutorial, since there's a perfectly good one here: Synology: 30 Second Portainer Install Using Task Scheduler & Docker. Thanks Marius. Naturally he offers many other guides for installing all kind of applications via docker and otherwise on Synology NAS.
3. Next, go to file station on your DSM, and create a location for WPS-Office configuration. Under it the documents folder will be created automatically once the suite is installed and use. Remember this location.
4. Once you got portainer up and working, you log in, and go to stacks. Click on "new stack", give it a name such as "wps-office" (without the quotation marks), and paste the following into the editor window:

5. ---
   services:
     wps-office:
       image: lscr.io/linuxserver/wps-office:latest
       deploy:
         resources:
           reservations:
             devices:
               - driver: nvidia
                 count: 1
                 capabilities: [compute,video,graphics,utility]
       container_name: wps-office
       security_opt:
         - seccomp:unconfined #optional
       environment:
         - PUID=1026
         - PGID=100
         - TZ=Etc/GMT
         - CUSTOM_USER=user
         - PASSWORD=pass
       volumes:
         - /path/to/wps-office:/config
       ports:
         - 3000:3000
         - 3001:3001
       shm_size: "1gb"
       restart: unless-stopped

6. Do note a few things:
7. PUID and PGID values may be different for you, so in order to verify what they are, you can open a ssh terminal to your server, and run "id your_user" (replace your_user with your actual user).
8. This docker-compose file includes acceleration support for Nvidia cards. As most don't have that, you can use this instead (or remove the relevant lines):

9. ---
   services:
     wps-office:
       image: lscr.io/linuxserver/wps-office:latest
       container_name: wps-office
       security_opt:
         - seccomp:unconfined #optional
       environment:
         - PUID=1026
         - PGID=100
         - TZ=Etc/GMT
         - CUSTOM_USER=user
         - PASSWORD=pass
       volumes:
         - /path/to/wps-office:/config
       ports:
         - 3000:3000
         - 3001:3001
       shm_size: "1gb"
       restart: unless-stopped

10. Change the TZ=Asia/Singapore to reflect your actual location according to this wikipedia page: https://en.wikipedia.org/wiki/List_of_tz_database_time_zones
11. Change the CUSTOM_USER value from user to whichever user you wish, and the PASSWORD=pass value from pass to whichever password you prefer. This will allow secure access to your office suite.
12. Change the volume "/path/to/wps-office" to the folder you created in file station eariler
13. Alternatively, if ports 3000/3001 are already taken by other dockers/applications, you can ammend them to XXXX:3000 and XXXX:3001 whereis XXXX are the new available ports
14. Once all is done, simply scroll down and click "deploy stack". If you haven't messed the syntax (portainer is not forgiving about it and will not let deploy if it's wrong), the stack will start pulling the image and building the container. Give it a few minutes. Go get a snack, or coffee.
15. Once the windows changes to the stacks list, you are in business. Simply open a new tab or window, enter "http://synologynas:3000" (or whichever your server name and port chosen are), and you will be greeted by user/pass request like this:
16. which you will enter, and then you are in! You will see something like this: 
17. On the bottom left, where I pointed with an arrow, are the wps-office applicationsm from left to right: WPS Writer (word), WPS Presentation (powerpoint), WPS Spreadsheets (Excel), WPS PDF (Kingsoft PDF reader), Chromium web browser, and Thunar File manager.

 

For more information about this docker and its switches, you can go here (also allows for iGPU acceleration which I didn't include): https://hub.docker.com/r/linuxserver/wps-office

 

Enjoy!