Portainer Templates logo

Portainer Templates

Neko Neko

Stack

Other

Simple room management system for n.eko. Self hosted rabb.it alternative. --Please add .env file as stated in neko.yml

Configuration

Type
Compose
Platform
linux
Source
Repo

Template by xneo1·Source

Services

traefik

Configuration

Image
traefik:2.4
Ports
580:805443:443
Volumes
/var/run/docker.sock : /var/run/docker.sock/etc/traefik/traefik.yml : /portainer/Files/AppData/Config/traefik/traefik.yml/usersfile : /portainer/Files/AppData/Config/traefik/usersfile/acme.json : /portainer/Files/AppData/Config/traefik/acme.json/config : /portainer/Files/AppData/Config/traefik/config
Env vars
TZ=
Restart
unless-stopped

Image details

Pulls: 3.5B
User: library
Created: Apr 06, 2016
Updated: 3 days ago
Status: active

neko-rooms

Configuration

Image
m1k1o/neko-rooms:latest
Volumes
/var/run/docker.sock : /var/run/docker.sock
Env vars
TZ=NEKO_ROOMS_EPR=NEKO_ROOMS_NAT1TO1=NEKO_ROOMS_TRAEFIK_DOMAIN=NEKO_ROOMS_TRAEFIK_ENTRYPOINT=NEKO_ROOMS_TRAEFIK_CERTRESOLVER=NEKO_ROOMS_TRAEFIK_NETWORK=
Restart
unless-stopped

Image details

Pulls: 407k
User: m1k1o
Created: Mar 12, 2021
Updated: 3 months ago
Status: active

Standalone Install

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

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 Neko, 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:

#
# This docker compose needs .env file.
# Copy .env.example to .env and modify.
#

networks:
  default:
    attachable: "true"
    name: "${NEKO_ROOMS_TRAEFIK_NETWORK}"

services:
  traefik:
    image: "traefik:2.4"
    restart: "unless-stopped"
    environment:
      - "TZ"
    ports:
      - "580:80"
      - "5443:443"
    volumes:
      - "/var/run/docker.sock:/var/run/docker.sock:ro"
      - "/portainer/Files/AppData/Config/traefik/traefik.yml:/etc/traefik/traefik.yml:ro"
      - "/portainer/Files/AppData/Config/traefik/usersfile:/usersfile:ro"
      - "/portainer/Files/AppData/Config/traefik/acme.json:/acme.json"
      - "/portainer/Files/AppData/Config/traefik/config:/config"

  neko-rooms:
    image: "m1k1o/neko-rooms:latest"
    restart: "unless-stopped"
    environment:
      - "TZ"
      - "NEKO_ROOMS_EPR"
      - "NEKO_ROOMS_NAT1TO1"
      - "NEKO_ROOMS_TRAEFIK_DOMAIN"
      - "NEKO_ROOMS_TRAEFIK_ENTRYPOINT"
      - "NEKO_ROOMS_TRAEFIK_CERTRESOLVER"
      - "NEKO_ROOMS_TRAEFIK_NETWORK"
    volumes:
      - "/var/run/docker.sock:/var/run/docker.sock"
    labels:
      - "traefik.enable=true"
      - "traefik.http.services.neko-rooms-frontend.loadbalancer.server.port=8080"
      - "traefik.http.routers.neko-rooms.entrypoints=${NEKO_ROOMS_TRAEFIK_ENTRYPOINT}"
      - "traefik.http.routers.neko-rooms.rule=Host(`${NEKO_ROOMS_TRAEFIK_DOMAIN}`)"
      - "traefik.http.routers.neko-rooms.tls=true"
      - "traefik.http.routers.neko-rooms.tls.certresolver=${NEKO_ROOMS_TRAEFIK_CERTRESOLVER}"
      - "traefik.http.routers.neko-rooms.middlewares=basicauth@file"

Or deploy it directly from the source:

git clone https://github.com/xneo1/portainer_templates
cd portainer_templates
docker compose -f Template/Stack/neko.yml up -d

More install options in our documentation.

Container Documentation

traefik Documentation

Traefik, The Cloud Native Edge Router

neko-rooms Documentation

Virtual browser rooms management in Docker.

Serve Neko 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 neko.example.com to http://traefik:80

Add this to your Caddyfile

neko.example.com {
	reverse_proxy http://traefik:80
}

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:580 failed: port is already allocated", something else on your server is using that port.

  • Find what's using it: sudo ss -tlnp | grep :580
  • Stop the other service, or pick a different host port. In 580:80 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:580. The 0.0.0.0 link Portainer shows isn't a real address.
  • Give it a minute after first deploy, neko can take a while to initialise.
  • Make sure your firewall allows the port, e.g. sudo ufw allow 580

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/traefik/traefik.yml (and the same for the other mapped folders)

Can't reach the Docker socket

neko talks to Docker through /var/run/docker.sock. If the logs show "permission denied while trying to connect to the Docker daemon socket", the app's user can't access it.

  • Check the socket exists on the host: ls -l /var/run/docker.sock
  • Run the container as root, or add the docker group's id to the container with group_add.

Image won't pull

Test the pull directly on the host: docker pull traefik:2.4

  • "manifest unknown" means the tag no longer exists.
  • "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.

Required settings are blank

TZ, NEKO_ROOMS_EPR, NEKO_ROOMS_NAT1TO1, NEKO_ROOMS_TRAEFIK_DOMAIN, NEKO_ROOMS_TRAEFIK_ENTRYPOINT, NEKO_ROOMS_TRAEFIK_CERTRESOLVER, NEKO_ROOMS_TRAEFIK_NETWORK have no default value, and neko may crash or misbehave if left empty.

  • Fill them in on the deploy screen before hitting deploy.

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

Neko 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:

  • traefik runs traefik:2.4
  • neko-rooms runs m1k1o/neko-rooms:latest

Ports

A port is the door the app answers on. A mapping like 580:80 means it's reachable on port 580 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:580 in a browser. It opens:

  • 580:80, likely the web interface
  • 5443:443, likely the web interface

Volumes

A volume is where Neko 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:

  • /var/run/docker.sock from /var/run/docker.sock on the host (a socket it talks to, not storage)
  • /etc/traefik/traefik.yml from /portainer/Files/AppData/Config/traefik/traefik.yml on the host
  • /usersfile from /portainer/Files/AppData/Config/traefik/usersfile on the host
  • /acme.json from /portainer/Files/AppData/Config/traefik/acme.json on the host
  • /config from /portainer/Files/AppData/Config/traefik/config on the host

Environment variables

Environment variables are the settings you hand over when you deploy, things like a password or a timezone. Neko takes 7 of them, and 7 need a value before it'll start properly:

  • TZ, needs a value
  • NEKO_ROOMS_EPR, needs a value
  • NEKO_ROOMS_NAT1TO1, needs a value
  • NEKO_ROOMS_TRAEFIK_DOMAIN, needs a value
  • NEKO_ROOMS_TRAEFIK_ENTRYPOINT, needs a value
  • NEKO_ROOMS_TRAEFIK_CERTRESOLVER, needs a value
  • NEKO_ROOMS_TRAEFIK_NETWORK, needs a value

Restart policy

The restart policy here is unless-stopped, so Docker restarts Neko 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 traefik) 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 Neko up. Add the template list to Portainer once, then deploying Neko is a click rather than a wall of config.