Skip to content

Latest commit

 

History

History
98 lines (78 loc) · 2.82 KB

README.md

File metadata and controls

98 lines (78 loc) · 2.82 KB
Raw

NxCloud

About

NxCloud is a fully rebrandable multi-tenancy cloud based DNS filter software by Jahastech. It is developed based on NxFilter and inherits most of the features of NxFilter.

Container image is based off of Ubuntu:latest minimal with the most current DEB package for NxCloud from NxFilter.

Usage

Interactive container for testing:

docker run -it --name nxcloud \
   -p 53:53/udp \
   -p 19004:19004/udp \
   -p 80:80 \
   -p 443:443 \
   -p 19002-19004:19002-19004 \
   deepwoods/nxcloud:latest

Detached container with persistent data volumes:

docker run -dt --name nxcloud \
  -e TZ=America/Chicago \
  -v nxcconf:/nxcloud/conf \
  -v nxcdb:/nxcloud/db \
  -v nxclog:/nxcloud/log \
  -p 53:53/udp \
  -p 19004:19004/udp \
  -p 80:80 \
  -p 443:443 \
  -p 19002-19004:19002-19004 \
  deepwoods/nxcloud:latest

Configuration

  • The admin GUI URL is http://[DOCKER_HOST_SERVER_IP]/admin
  • TZ of the container defaults to UTC unless overridden by setting the environment variable to your locale. see List of tz time zones

Docker-compose example

version: '3.5'

services:
  nxcloud:
    image: deepwoods/nxcloud:latest
    container_name: nxcloud
    hostname: nxcloud
    restart: unless-stopped
    environment:
      TZ: "America/Chicago"
    volumes:
      - nxcconf:/nxcloud/conf
      - nxclog:/nxcloud/log
      - nxcdb:/nxcloud/db
    ports:
      - 53:53/udp
      - 19004:19004/udp
      - 80:80
      - 443:443
      - 19002-19004:19002-19004
volumes:
  nxcconf:
  nxcdb:
  nxclog:

Useful Commands

docker-compose to start and detach container: docker-compose up -d

Stop and remove container: docker-compose down

Restart a service: docker-compose restart nxcloud

View logs: docker-compose logs

Open a bash shell on running container name: docker exec -it nxcloud /bin/bash

Warning Commands below will delete all data volumes not associated with a container!

Remove container & persistent volumes(clean slate): docker-compose down && docker volume prune

Updating

  1. Pull the latest container. docker pull deepwoods/nxcloud:latest
  2. Stop and remove the current container. docker stop nxcloud && docker rm nxcloud

Note If using docker-compose: docker-compose down

  1. Run the new container with the same command from above. Detached container

Note If using docker-compose: docker-compose up -d

  1. Make sure that the container is running. docker ps
  2. Check the container logs if unable to access the GUI for some reason. docker logs nxcloud

Note If using docker-compose: docker-compose logs