Akami Solutions CDN CGI Server

Description

The Akami Solutions CDN CGI Server represents a modernized version of the previous Akami Solutions CDN CGI missing pages.

As of the current status (March 26, 2024), an independent PHP file was generated for each HTTP status code. Using a reverse proxy, requests were forwarded to the respective file depending on the HTTP status code. In contrast, the current version works with an additional web server that can operate on any port. This allows requests containing cdn-cgi to be forwarded to this server using a reverse proxy.

Functionality

To illustrate how this system works, let's take the example of a web hosting provider that uses NGINX and this Node.js server.

The website host configures NGINX so that when the path /akami-cgi/ appears in the URL, the request is redirected to this server. In practice, this means that when such a call is made, the normal loading of the website is interrupted and the Akami Solutions CDN CGI server takes control instead.

Environment Variables

The system utilizes the following environment variables:

• VERSION - represents the version number of the server.
• SERVER_PORT - represents the port on which the server listens.
• SERVER_HOSTNAME - represents the hostname for the server.
• SERVER_LOG_LEVEL - determines the log level used by the server.
• PATH_IDENTIFIER - indicates the path name in the URL for which requests will be redirected to this server.
• REDIS_HOST - The hostname of your Redis Server
• ASSETS_CACHE_TTL - The TTL in milliseconds how long resources like style and other static resources should be stored in between.
• IP_DATA_CACHE_TTL - The TTL in milliseconds for how long the IP data should be temporarily stored in the Redis cache.
• XRAY_RESOLVER_UA - The user agent to be used when an IP is to be resolved. (Is forwarded to RIPE)

Installation and setup

Setting up the Akami Solutions CDN CGI server requires the following steps:

1. First, install the Node.js server using npm or the package manager of your choice.
2. Then create a corresponding configuration file for NGINX.
3. Then update the path in the configuration file to direct /akami-cgi/ to your Node.js server.
4. Lastly, set the environment variables in your system accordingly.

The exact setup details and examples can be found in the installation instructions.

Docker support

Akami Solutions CDN CGI Server provides full support for Docker. You can use a Docker container to easily deploy and manage the server. We provide a pre-built Dockerfile that simplifies container setup: you may need to use different identifiers, tags or ports depending on your specific application and configuration. Please see the Docker documentation for more details. You can use this Dockerfile to create a Docker image and run the CDN CGI Server in a Docker container. To build the Docker image and start the container, please use the following commands:

1. Build the Docker image:

docker build -t akami-cdn-cgi-server:1.0 .

2. Start the Docker container:

docker run -p 3000:3000 -d akami-cdn-cgi-server:1.0

Please note that you may need to use different identifiers, tags or ports depending on your specific application and configuration. For more information about using Docker, see the official Docker documentation.

Docker-Compose

In addition to Docker support, the CDN CGI Server can be also operated using Docker Compose. Below is a sample docker-compose.yml that gives an example of how Docker Compose can launch the service:

version: "3.8"
services:
  cdn-cgi-server:
    image: ghcr.io/akama-aka/akami-statuspage:development
    environment:
      - VERSION=1.0.0.2
      - SERVER_PORT=8080
      - SERVER_HOSTNAME=127.0.0.1
      - SERVER_LOG_LEVEL=info
      - PATH_IDENTIFIER=akami-cgi
      - REDIS_HOST=redis-server
      - ASSETS_CACHE_TTL=2592000
      - IP_DATA_CACHE_TTL=7884000000
      - XRAY_RESOLVER_UA=Your-CDN/1.1.2${VERSION}
    ports:
      - 8080:8080
    depends_on:
      redis-server:
        condition: service_started
        required: true
  redis-server:
    image: redis:7.2.4-alpine
    ports:
      - :6379
    restart: always
    healthcheck:
      test: [ "CMD", "redis-cli", "--raw", "incr", "ping" ]

To start the Docker Compose stack use this command:

docker-compose up -d

Support and troubleshooting

For support and troubleshooting, please get in contact with me via mail. For more serious problems, please do not hesitate to contact me!

Important

This is not a 100% production representation that Akami Solutions uses. Akami Solutions uses a better, cleaner and more maintained Version of the Code