Portainer Templates logo

Portainer Templates

Nitter Nitter

Stack

OtherToolsWeb

A free and open source alternative Twitter front-end focused on privacy and performance.

Configuration

Type
Compose
Platform
linux
Restart
unless-stopped
Source
Repo

Template by novaspirit·Source

Notes

Template created by Pi-Hosted Series
Check our Github page: https://github.com/pi-hosted/pi-hosted

Official Webpage: https://nitter.net/
Official Docker Documentation: https://github.com/zedeus/nitter


Services

nitter

Configuration

Image
quay.io/unixfox/nitter:latest
Ports
3300:8080
Volumes
/data : /portainer/Files/AppData/Config/nitter/data
Env vars
REDIS_HOST="redis"
Restart
unless-stopped

redis

Configuration

Image
redis:alpine
Volumes
/data : /portainer/Files/AppData/Config/nitter/redis
Restart
unless-stopped

Image details

Pulls: 11.1B
User: stackbrew
Created: Jun 05, 2014
Updated: 9 days ago
Status: active

Standalone Install

Select an install method, to see config/commands for deploying Nitter

Installation method

Install on Portainer

Import all app templates into your Portainer instance, for easy 1-click deploys

  1. Ensure both Docker and Portainer are installed, and up-to-date
  2. Log into your Portainer web UI
  3. Under Settings → App Templates, paste the below URL
  4. Head to Home → App Templates, and the list of apps will show up
  5. Select Nitter, fill in any config options, and hit Deploy

Template Import URL

https://raw.githubusercontent.com/Lissy93/portainer-templates/main/templates.json
Show Me demo
Original stackfile

The compose file this template deploys, straight from its repo:

version: "3"

services:

  nitter:
    image: quay.io/unixfox/nitter:latest
    container_name: nitter
    networks:
      - nitter_network
    restart: unless-stopped
    depends_on:
      - redis
    volumes:
      - /portainer/Files/AppData/Config/nitter/data:/data
    ports:
      - 3300:8080
    environment:
      - REDIS_HOST="redis"

  redis:
    image: redis:alpine
    container_name: redis
    networks:
      - nitter_network
    restart: unless-stopped
    volumes:
      - /portainer/Files/AppData/Config/nitter/redis:/data

networks:
  nitter_network:

Or deploy it directly from the source:

git clone https://github.com/pi-hosted/pi-hosted/
cd pi-hosted
docker compose -f stack/nitter.yml up -d

More install options in our documentation.

Container Documentation

redis Documentation

Redis is the world’s fastest data platform for caching, vector search, and NoSQL databases.

Serve Nitter on your own domain behind Caddy, Nginx or Traefik. Fill in your domain and copy the result. It's a starting point, some apps need their own base URL or extra headers set too.

Proxying nitter.example.com to http://nitter:8080

Add this to your Caddyfile

nitter.example.com {
	reverse_proxy http://nitter:8080
}

Check the logs first

Nine times out of ten the logs tell you exactly what went wrong.

  • In Portainer, go to Containers, click the container, then Logs. Or run docker logs <container>
  • Exit codes help too: 137 means killed, usually out of memory. 126 or 127 means the command inside the image is broken.

Port already in use

If deployment fails with "Bind for 0.0.0.0:3300 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :3300
  • Stop the other service, or pick a different host port. In 3300:8080 only the left number is yours to change, the right one belongs to the app.

Running but the page won't load

The container is up but nothing appears in your browser.

  • Use your server's real IP: http://your-server-ip:3300. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, nitter can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 3300

Permission denied on volumes

If the logs show "permission denied", the app can't write to its data folder on the host.

  • Fix the ownership: sudo chown -R 1000:1000 /portainer/Files/AppData/Config/nitter/data (and the same for the other mapped folders)

Image won't pull

Test the pull directly on the host: docker pull quay.io/unixfox/nitter:latest

  • "manifest unknown" means the tag no longer exists. This template uses latest, so try pinning a specific version instead.
  • "toomanyrequests" is the Docker Hub rate limit. Log in with docker login to raise it.
  • "no space left on device" means a full disk. Reclaim space with docker system prune

"exec format error"

This means the image was built for a different CPU architecture than your server.

  • Check yours with uname -m: x86_64 is amd64, aarch64 is arm64. Raspberry Pi and other ARM boards are the usual culprits.

Container keeps restarting

The unless-stopped restart policy relaunches the app after every crash, so the real error can scroll past.

  • Check the logs right after a restart, the last few lines before it died are the useful ones.
  • Get the exit code with docker inspect <container> --format '{{.State.ExitCode}}'
  • Still stuck? Redeploy once with the restart policy set to no so the failure stays visible.

Stack won't deploy

Compose stacks fail fast on small mistakes, and Portainer shows the reason just above the editor.

  • YAML only accepts spaces for indentation, a single tab breaks the whole file.

Raise an issue

Found something which isn't working as it should? Here's how to report it.

A Compose stack

Nitter is a Compose stack, a set of containers (2 of them) defined in one file and brought up together by Portainer, then started and stopped as a single app.

The services

This stack is built from 2 containers that run side by side. Here's each one, with the image it runs and anything it waits for first:

  • nitter runs quay.io/unixfox/nitter:latest, starts after redis
  • redis runs redis:alpine

Ports

A port is the door the app answers on. A mapping like 3300:8080 means it's reachable on port 3300 of your server, where the left number is yours to change and the right one belongs to the app. Once it's running, open http://your-server-ip:3300 in a browser. It opens:

  • 3300:8080, likely the web interface

Volumes

A volume is where Nitter keeps its files so they survive an update or a restart. Without one, anything it saves would sit inside the container and vanish the moment it's recreated. This template mounts:

  • /data from /portainer/Files/AppData/Config/nitter/data on the host
  • /data from /portainer/Files/AppData/Config/nitter/redis on the host

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Nitter takes 1 of them, all with defaults you can leave alone or tweak:

  • REDIS_HOST, defaults to "redis"

Restart policy

The restart policy here is unless-stopped, so Docker restarts Nitter after a crash or reboot, but leaves it off when you stop it on purpose. You can change this on the deploy screen. The choices are no (never restart), on-failure (only after a crash), unless-stopped (restart unless you stop it), and always (bring it back no matter what).

Networking

Portainer puts these services on one shared private network, so they can find each other by name (like nitter) while only the ports above are open to you.

Platform

The platform is linux, the kind of system the container is built to run on. Docker and Portainer handle this on a normal Linux server.

Portainer app templates

Zooming out, this whole page comes from a Portainer app template: a short recipe telling Portainer how to set Nitter up. Add the template list to Portainer once, then deploying Nitter is a click rather than a wall of config.