README.md

PortaNexus

A mobile connection for your Portainer instance

View, control and manage your portainer instance from your smartphone (Android support only for now).

Login with your Portainer Instance URL and your API Key, check Portainer documentation on how to generate an API Key for your instance.

For the Portainer Instance URL be sure to add the route /api

Example of Portainer Instance URL: https://example.tld/api

Android

Support currently through apk file that can be downloaded from the github releases page of this repository.

iOS

The support for iOS is only through PWA at the moment.

Progressive Web App (PWA) Installation and Usage using Docker

There is a Dockerfile which you can use to build the portanexus application.

For convenience there is also a Docker image being maintained on docker hub tiagorvmartins/portanexus

Compose

services:
  portanexus:
    image: tiagorvmartins/portanexus-web:v0.1.4
    ports:
      - "8080:80  # You can change the binded port on host to your needs if needed

Reverse Proxy configuration to expose PortaNexus (sample using caddy)

portanexus.your-domain.ltd {
  reverse_proxy http://127.0.0.1:8080  # or the port that you changed to
}

Portainer Extra Configuration for CORS

There is an extra configuration to be done on Portainer to allow CORS request from the browser

portainer.your-domain.ltd {
  
  // ...
  // your extra configurations
  // ...

  @cors {
    method GET POST
  }

  header @cors Access-Control-Allow-Origin "*"

  # Handle OPTIONS requests
  @options {
    method OPTIONS
  }

  header @options Access-Control-Allow-Origin "*"
  header @options Access-Control-Allow-Headers "Authorization, Origin, X-Requested-With, Content-Type, Accept, X-Api-Key"
  header @options Access-Control-Allow-Methods "GET, POST, OPTIONS"
  respond @options "" 200
}

Screens Showcase (v0.1.4)

Login Screen

Light Theme	Dark Theme

Drawer Screen

Light Theme	Dark Theme

Endpoints Screen

Light Theme	Dark Theme

Containers Screen

Light Theme	Dark Theme

Stacks Screen

Light Theme	Dark Theme

Container Logs Screen

Light Theme	Dark Theme

Settings Screen

Light Theme	Dark Theme

Planned Roadmap

Roadmap