PreludeI'm pleased to say I will be releasing an add-on for Farmer Joe Render Farm which will work with a newly patched version of Farmer Joe for Blender 2.80 and above. This tutorial is me documenting my efforts to create a stable linux host for the render farm so that I can do it again if I need to, and also so those of you, who, like me, have little interest in Linux, can build a box that does what you want and move on to other things.
Farmerjoe is now available here https://github.com/Laurencitow/Farmer-Joe-Render-Farm
IntroductionSpurred on by a recent video showing how much faster linux can be rendering blender files I forgot previous attempts at using linux as a render node OS and had another go.
I must admit after a week of mucking about, getting this to work, I now wholeheartedly appreciate Microsoft Windows: it's stability, forgivingness and ability to heal itself. It's much, much easier to do stuff on windows when you don't know what you are doing than Linux.
That said, here we go. I was setting out to create an install of linux that would:
- run VNC server so I could control the render node from a main, Windows computer.
- have fully functioning Nvidia drivers for running blender (AMD? you're on your own - sorry)
- have auto login
- be able to share a folder from the render computer that windows can easily see and use
- be able to see and use a folder shared from windows ... easily
- run Farmer Joe at login
- and finally be strong and stable 😁
PLEASE ENSURE THE SECURITY YOU USE SUITS YOUR NEEDS. WHAT IS SHOWN HERE IS A GUIDE ONLY AND I AM NOT LIABLE FOR ANY LOSSES YOU MIGHT SUFFER IF YOUR SECURITY IS INADEQUATE.. sorry, but these things have to be said..
You will need a Dummy HDMI dongle to fake a screen attached (look on eBay)(assuming your graphics card has an HDMI output of course).
"1.4 DDC EDID Dummy Plug Display Emulator VGA 1080 Virtual Display Adapter HDMI"
If you are using a Windows PC to control your render nodes I recommend TightVNC viewer.
For Linux, I tried Ubuntu, Mint, Manjaro, MX and Debian Linux. Got a long way with Manjaro but found it really flakey and unreliable and in the end transferred what I had learnt to Debian: renowned for it's stability.
Debian can exist along side windows but you have to do extra steps if you have UEFI enabled on windows... not covered here so google it. Also there are problems with windows updating afterwards.
I hope I have got all the steps right in this tutorial...
*** ALSO I AM NOT RESPONSIBLE FOR ANY LOSS OF DATA YOU MIGHT SUFFER***
so be careful...
Installing DebianDownload from here https://www.debian.org/CD/http-ftp/#stable and use Rufus to make a bootable USB drive. This tutorial is made with Debian 10.1.0 and used the debian-10.1.0-amd64-netinst.iso file.
Boot from the USB drive on your render computer and follow the instructions. Choose Graphical Install.
You should have chosen your computer/username and simple password.
First thing you need to get right is partitioning the disk. If its the whole disk you are using then it's easy but if you want to delete a partition and use that the menu system is a bit quirky. Using the whole disk use Guided - Use Entire Disk.. Otherwise choose Manual
- delete the partition
- select the free space you have created
- select 'Automatically partition free space' and then 'All files in one partition'
- 'Finish partitioning and write changes to disk' and the next screen you have to confirm this.
- no to a proxy (unless you need it)
- yes to a grub drive and select the drive you system is on if there's more than one disk
When it come software selection page:
- select XFCE
- keep Standard System Utilities selected
- Deselect EVERYTHING ELSE
Your computer name is the same as your login name and all the passwords are simple and the same (at least that's what I've done)
The rest should be straight forward.
First boot and installing thingsChoose the 'default panel' option in the dialogue that appears.
We are going to install things two ways: the Synaptic Package Manager and the terminal.
From the Applications button go to Settings/ Synaptic Package Manager (need password)
Under Settings/Repositories. In the top two ticked selections, in the 'Section(s)' section make sure it says 'main', add 'contrib' and 'non-free'.
Press the Reload button
This allows us do download the proprietary drivers
When done click OK
(if you have problems here it might be worth changing repository)
Click search on the right hand side and put in 'Nvidia Driver'. Scroll down the search results until you come to Nvidia Driver. Right click and select 'Mark for Installation'. (AMD? you're on your own - sorry)
You'll see another screen showing you all the other stuff you are going to install. Say yes. then click apply. It will take a while... its a big file to download and process.
You need to add Cuda files for Cycles (which I forgot to do earlier as I hadn't tested cycles.)
Search for 'cuda'. You need the nvidia-cuda-dev and nvidia-cuda-toolkit. The other items in green will be included with these.
Next while we are in Synaptic Package Manager search for 'TigerVNC'.
You need these packages.
Finally search for 'Numix' and add the Numix icons. The default restart icon looks like a medieval diagram of a stomach. Numix is more intelligable.
When done open XFCE Terminal from Applications.
You will be asked for a password. Type the password you are using for everything and confirm it.
It will ask if you want a 'view only' password... I would say 'No' or 'n'
Before we go any further you might want to add 'Restart' option to the 'Action Buttons' (top right hand side) and move the 'Action Buttons' to the left hand side and add the Numix icons (Settings/Appearance/Icons).
Right click on the right hand most 'button' marked with your username and select properties. Change to Session Menu to Action Buttons. Untick everything except shutdown, Logout and tick restart. We would get rid of logout you will need it to finish off later. You can move some separators to make it look nice.
Right click on your new Action Buttons and select Panel then Preferences and then Items. You can move things about on the top bar. Make sure your Action Buttons are now on the left hand part of the screen in case of screen shrinkage. If your VNC window is smaller than your actual window you won't loose the restart and shutdown buttons if they are here.
It's a bit clunky and I'll leave you to figure it out but you might end up with something like this.
For the icons go to Applications/Settings/Appearance and choose the Numix icons. Now your restart button doesn't look so stomachy.
You might want to add the handy CPU monitor too!
Important - switch off all power settings.. if the screen goes blank.. it will stay blank
Applications/Settings/Power Manager. When power button pressed to Shutdown (may be useful oneday). Make sure system and display are set to 'Never'.
Installing networking stuffWith terminal still open we can install networking stuff.
For some reason the 'SUDO' command does not do what I'm used to in Debian so we use 'su root'.
Typing 'su root' in the terminal is the same as opening the command prompt as an administrator in Windows. After you've typed it and put in the password you are root administrator.
Installing Samba (Networking):
apt-get install samba
and type 'y' for yes if prompted.
When asked about WINS select yes.
when done type -
apt-get install samba-client
This looks after linux shares.
apt-get install cifs-utils
For mapping windows shares
While we are here lets add Gparted (partitioning software) because it's useful:
apt-get install gparted
Finally we are going to set the render computer to auto logon.
Still as su root, type:
in the terminal there will be loads of warnings because they don't like you using mousepad but we don't care. Mousepad text editor will open. There should be some configuration stuff in there already (if there isn't you've made a typo in the above line). Add these lines to the bottom where USERNAME is your login and computer name.
Save and exit mousepad and type 'exit' in terminal to exit root.
scroll down - you need to add gvfs-backends, gvfs-fuse and gvfs-bin
Close Synaptic Package Manager
I think now is a great time to reboot. And hopefully your computer should log straight in.
When it boots up I would load this tutoral on the webrowser in your render node so that you can easily copy some of the scripts that follow.
Unlike Windows, VNC on linux does not necessarily give you what you see on the screen. Perish the thought! You can have many different VNC connections to many different virtual screens. What is difficult is getting it to show you whats on the actual screen and as we are using Blender this is important that we do. (Just trust me here). So we use a much maligned TigerVNC feature: the X0vncserver. And this shows you the actual screen and (with Debian anyway) behaves well with the Nvidia drivers.
At the moment you will be plugged into a monitor and you probably won't want your VNC window to be as big as the monitors default resolution. X0vncserver will probably crash if you change resolutions with it running so we have to set this first. It's complicated by the fact that your HDMI dummy dongle you will be using to replace the monitor has more resolutions available but more of that later.
We can set the display resolution in Applications/Settings/Display. Let's choose 1440x900
This is the command we will be using for VNC
x0vncserver -display :0 -geometry 1440x900 -rfbport 5900 -passwordfile /home/USERNAME/.vnc/passwd
I have found it necessary to have the resolution in the command otherwise things go wrong. So if you change the resolution again you will have to change it in the x0vncserver command. I have found that when using the Dummy HDMI dongle X0vncserver is less likely to crash if you change resolution.
You can configure x0vncserver as a service but we are going to use the Applications/Settings/'Session and Startup' app to do it because its easier. Go to 'Application Autostart'. Create a new entry called VNC and paste the above command into the command field.
If you reboot the render node x0vncserver should be running at startup and you should be able to connect to it from you PC. You will need the password. When you are connected you can click the disk icon in the top left hand corner of the window and save the connection information to the desktop. It will then ask you to save the password too!
Having already installed all we need its time to configure.
Shares are shared using the Samba smb.conf file which lives in /etc/samba.
Drives are mounted in the fstab file which is located in the /etc/ directory.
To add a little more detail here, and especially in Debian where extra hard disks are not automatically mounted, we create a folder in the filing system and mount the drive as if it appears in that folder. So in windows we sort of mount a drive to a drive letter, in linux we mount it to a folder name. And the same is true if we are mapping a shared drive from an existing computer.
Mounting drives with fstab
First run Gparted which we installed earlier.Applications/System/Gparted. Each disk and partition have a code. The first disk is usually SDA and the second SDB and each partition a number so the third partition on the second disk is SDB3.
Note down which one you want to mount.
In terminal run:
ls -l /dev/disk/by-uuid/
The blue number/letter codes are the UUIDs of the partitions on the disk. Identify the one you want from the SDxx code in yellow at the end of each line and copy it (just the blue) to the clip board. For me sda2.
Type 'su root' to become an administrator and type 'mousepad /etc/fstab' . There should be enteries in there already or you have made a mistake.
Make a comment to indicate what you are adding. The Hash key does not work for some reason so you will have to copy it from another line.
I am going to add this line:
UUID=01D57AE18561B120 /media/data ntfs defaults 0 0
where /media/data is a folder I have created in the media directory to map the drive. ntfs is the file system. Linux supports many. Defaults are the options and the two zeros are 'dump' and 'pass' what ever that is. The spaces are tabs.
Under the latest special linux rules. Permanent drives are mapped to /Mnt/ and removable drives are mapped to /Media/.
(If we want to make a folder to map to - say /media/renders we will need to do in terminal as root with mkdir /media/renders ). Any folders/files outside the users home directory are root permissions only and require 'su root'. If you want to see the whole filing system go to the File Manager and look at File System.
If we want to add a windows share from another computer as a perminantly mounted drive then..
//SERVER_IP/SHARENAME /media/MOUNTDIRECTORY cifs auto,nofail,x-system.device-timeout=10,username=USERNAMEOFSERVER,password=PASSWORDOFSERVER,uid=1000,iocharset=uft8 0 0
Spaces inbetween are tabs.
If the share isn't present at boot time then the computer will take a little longer to boot
You can use a hostname as long as the computer can resolve it, you should use static ip addresses really though DHCP computers tend to keep their ip addresses. The UUID here should be unique if you add another share and you can get a UUID generator program.
The username and password here are for the windows box you are sharing from so you may not wish to include the password depending on your situation. There are other more secure ways of storing passwords to shares not covered here.
Save the fstab file. and exit 'su root'. If you have made a mistake then... BOOOOOOMM!!! you'll be pluging that monitor back in again.
Reboot and check to see if the share is mapped to the mount position.
If the share has not been mapped try mount -a in terminal as root (this reloads the fstab file). If you get an error you might have to start from scratch again as there is obviously a problem with networking.
If it does map with is command it could be that your computers hardware is slower to get the network stuff up and running and not ready when fstab is run. In this case we need to do something else.
If the FSTAB mapping failsWe can not use mount -a as it only gives us read only permissions.. so
Firstly we're going to create a handy place for some scripts. In the users home directory create a folder named 'scripts' using the File Manager and in it, right click, and create and empty file called startup.sh
then in terminal in as root type chmod +x /home/USERNAME/scripts/startup.sh and this will make the file executable.
edit the file in Mousepad as follows:
mount -t cifs -o username=USERNAME,password=PASSWORD,uid=1000,iocharset=utf8, file_mode=0777,dir_mode=0777 //SERVERADDRESS/SHARENAME /media/MOUNTNAME
and save. Now in terminal as root type
crontab -e and if it gives you a choice select 'nano'
cursor down to the bottom of the file and type
@reboot sleep 10 && /home/USERNAME/scripts/startup.sh
type 'Ctrl X' and they 'y' and return to save.
the number after sleep is how long after boot it will try and map the share. I found 5 was too short so settled for 10. You may need to experiment leaving a margin for error.
Sharing things with smb.confI wasted many hours trying to come up with a simple way of sharing things from Linux. In the end I used this smb.conf from user Adriano P on Serverfault.com who offered this example.
[global] workgroup = WORKGROUP server string = Samba Server %v netbios name = COMPUTERNAME security = user map to guest = bad user dns proxy = no #============= Share Definitions ================= [NAME_OF_SHARE] force user = USERNAME path = /home/USERNAME/renders browsable =yes writable = yes guest ok = yes read only = no
This entry in /etc/samba/smb.conf will share the 'renders' folder in the user's home directory WITHOUT asking for any username or password. There were some 'tutts' from other users about security in the thread but this is what I want. If you want security there are plenty of examples on the web. You can add as many shares as you like by copying and renaming the [NAME_OF_SHARE] section.
To set up this file. 'su root' in terminal and type 'mousepad /etc/samba/smb.conf'. There will be an existing file which I suppose you should back up. Then after deleting all the entries from the old file, type or paste the above changing the words in Capitals to your own values and save as smb.conf.
On reboot you should be broadcasting your shares and you should be able to see them in windows.
MiscIf you want you can remove libreoffice because we don't need office on here.
apt-get remove --purge libreoffice*
FarmerJoeTo be a render 'node' in a Farmer Joe render farm you will normally use the .sh file as the .pl is there if you want to develope the software further.
If you want to run the Farmer Joe perl script use Synaptic Package Manager to install libyaml-tiny-perl and libio-compress-perl.
If you want to compile your own .sh from the perl script you will need, in terminal root, apt install libpar-packer-perl
You will have mounted the share that Farmer Joe resides on as something like /media/renders and the FarmerJoe.sh file or perl script (.pl) will be in the root.
We want to run this, at boot, after the share has been mounted and in a terminal window.
The only way I have found to do this is as follows.
We are going to make another .sh file in our 'scripts' folder (more details in the 'If the FSTAB mapping fails' section). If you haven't made the 'scripts' folder make one in /home/USERNAME/ and in it make an empty file 'fj.sh'.
In terminal as root they chmod +x /home/USERNAME/scripts/fj.sh to make it executable.
Edit the file in Mousepad and add the lines:
xterm -e /media/MOUNTNAME/farmerjoexx.sh
or .pl if its a pl script. Here sleep should be a bigger value than the one set to map the share if used. 15 should be fine.
For the master computer where you are running a master, node and webserver you can use the line:
xfce4-terminal -T Master -e "/media/renders/Farmerjoe.pl --master" --tab -T Node -e "/media/renders/Farmerjoe.pl" --tab -T Webserver -e "/media/renders/Farmerjoe.pl --appserver" &
This will put them in three tabs in same window. xfce4-terminal has a bigger font by default
You can open a web browser on the Farmerjoe webpage with xdg-open http://IPADDRESS:2007
Finally, in 'Applications/Settings/Session and Startup' add a new entry in 'Application Autostart', as we did for VNC, called 'Farmer Joe' and give it the command line:
Reventing sessions from being restoredNormally it does not bother us if windows reopen as they were when we log in, but with FarmerJoe we can end up with dead windows from before with new windows from out startup file.
XFCE makes damn sure your session comes back when you reboot so it's hard work stopping it. You have to do three things.
First press logout
Then in 'Settings/Session and Startup' make sure 'Automatically save session on logout' is unchecked.
then, still in Session and Startup go to the 'Session' tab
and with all other windows closed press clear saved sessions and close 'Sessions and Startup' and cross your fingers :)
And reboot..... and good luck - if the Farmer Joe drive is available and mapped you should be running as a NODE.
If you run into problems I would seriously consider starting again from scratch. It will be faster in the long run.