Unraid

Unraid Docker Container Community Apps Installation Guide

Please note - For Unraid, I have released a 'Community Apps' template which has simplified the installation of Nitter on your device allowing you to jump to step 15 once you have found Nitter in the Community Apps page. However, if you wish to install directly from DockerHub yourself you can continue to follow these steps.

This Unraid Docker Installation guide will mostly assume a few things;

1. You have docker enabled within Unraid
2. You have enabled community apps within Unraid
3. You have enabled within settings the ability to utilize dockerhub for search results (see settings within apps tab)
4. OPTIONAL - You have a reverse proxy container and network to allow for certificate handling & SSL connections

With that in mind, the installation of Nitter is rather simple once you have the above setup.

5. Head over to apps and search for Nitter, click the 'Click Here To Get More Results From DockerHub' hyperlink to give more results.

6. Click to begin the installation of Nitter within the search result. (The repo is zedeus/nitter)

7. Set the toggle on the right in the template as ‘advanced view’ (It defaults to basic view)

8. Set your ‘Icon URL’ as https://raw.githubusercontent.com/zedeus/nitter/master/public/logo.png (This will provide you with the Nitter logo)

9. Set your ‘WebUI’ as http://[IP]:[PORT:8080]/ (This could be changed to whatever suits your local server port requirements - see below)

10. Set ‘Extra Parameters’ as --restart=always

11. Set your network type as needed (OPTIONAL - Set network type as your network that you utilize for your SSL certs (for me its proxnetwork).)

12. Add in your static IP address that you will utilize for Nitter. (This can be configured to suit your reverse proxy. You can even leave it empty if that's easier. I found in my setup that it was easier for me to have the IP set as a static entry.)

13. Add in a ‘path’ as;

• Name – Appdata
• Container Path - /config
• Host Path - /mnt/user/appdata/nitter (this could be changed to whatever suits your local server path requirements if your appdata path is different)
• Default Value - /mnt/user/appdata/nitter (see above)
• Acccess Mode – Read/Write
• Description – Appdata location

14. Now add in a ‘port’ as;

• Name – Port
• Container Port – 8080
• Host Port – 8080 (this could be changed to whatever suits your local server port requirements if your 8080 is already in use)
• Default Value – 8080 (this could be changed to whatever suits your local server port requirements - as above)
• Connection Type – TCP
• Description – Container Port: 8080

15. Uncheck the ‘Start Container After Install’ checkbox. (We need to add the nitter.conf prior to starting the container)

16. Click apply to download/install the container.

17. Ensure you have an up to date Redis container (from the community apps repos or roll-your-own)

18. Now to generate the required ‘nitter.conf;’

• Enter terminal from the webGUI of Unraid and navigate over to /mnt/user/appdata/nitter
• Use your terminal text editor of choice (vi or nano) For example – nano nitter.conf
• Paste in the contents of the nitter.conf directly from https://github.com/zedeus/nitter/blob/master/nitter.conf
• Update your nitter.conf to your desired settings, including redis details.

19. Start your Nitter docker container
20. OPTIONAL – Head over to your SSL cert provider container of choice and set-up as necessary to server certs to your Nitter instance for your domain.