Skip to main content

Getting started

An brief history of apnscp, how to download it, and use it.

Introduction

Features

apnscp works best with at least 2 GB for services + caching. Additional features may be installed:

Service ? Bottleneck Description
apnscp Required - Control panel frontend/backend
mcache Recommended Memory PHP opcode + session in-memory
vscanner Optional CPU Real-time upload filtering, well-known URI lockdown
mscanner Optional Memory, CPU Mail scanning, aggregate Bayesian DB
rampart Recommended CPU Real-time brute-force deterrent, DoS filtering
argos Recommended CPU Monit monitoring profiles + push notification

Proactive and Reactive Monitoring

Argos is a configured Monit instance designed to afford both proactive and reactive monitoring. Rampart provides a denial-of-service sieve for reducing resource swells from misbehaving bots. apnscp includes disallowance of HTTP/1.0 protocol, by default, to reduce malware. All components work to keep your sites more secure by filtering out garbage. tuned works proactively by retuning system variables as necessary. apnscp ships with the virtual-guest profile active.

Installation

apnscp may be installed from the bootstrap utility. Once installed a 15-day trial begins. A license key may be purchased through apnscp.com.

Before installing, ensure the following conditions are met:

Bootstrapping apnscp

Run the command from terminal

wget -O - https://raw.githubusercontent.com/apisnetworks/apnscp-bootstrapper/master/bootstrap.sh | bash

The bootstrapper will install itself, as well as request a SSL certificate from Let’s Encrypt (FCRDNS requirement). Once setup, a password will be generated. Your admin username is “admin” and password listed at the end.

First Login

Visit https://<domain>:2083 to login to the panel as “admin”. This is the Administrator account that can add, delete, and suspend accounts. Site Administrators are administrators of accounts created by an Administrator and are conferred all the rights of a Secondary User, with the added benefit of adding on domain, creating databases, and limited sudo. Further service configuration profiles may be setup in the following sections.

Configuration

apnscp configuration is managed through conf/ within its installation directory, /usr/local/apnscp by default. Two files require configuration before usage:

  • database.yaml - cp, platform, and plugin database configuration
  • auth.yaml - miscellaneous authentication providers

Authentication Providers

apnscp uses a variety of third-party modules to enhance its presentation. The following providers are integrated and recommended that you setup an account with each to enhance your experience:

  • Twilio: SMS notifications
  • MaxMind: GeoIP location for unauthorized login notices
  • PushOver: push notifications of server events to phone. Part of Argos.

Initial Startup

apnscp will attempt to bootstrap SSL on first run using Let’s Encrypt. To do this, the machine name must be reachable. Additional certificate names may be configured in conf/config.ini. Each time additional_certs is changed, remove the server SSL directory data/ssl/account/MAIN then restart apnscpd, service apnscpd restart. A new certificate will be fetched and installed within a couple minutes.

Changing SSL Hostnames

Additional hostnames beyond the machine name (uname -n) can be configured by editing letsencrypt -> additional_certs in config.ini. To activate changes, remove the directory vendor/data/acme-client/accounts/live/MAIN, then restart apnscpd, service apnscpd restart.

Adding Sites

Sites may be added using AddDomain or in simpler form, add_site.sh. Advanced usage of AddDomain is covered under Managing Accounts

Logging In

apnscp may be accessed via https://:2083/ or via http:/// - an automatic redirect will occur in this situation. apnscp may be accessed from an addon domain through the /cpadmin alias.

Important Terms

Before

Customizing

See Programming Guide.

License

Unless otherwise specified, all components of apnscp and its subcomponents are (c) 2017 Apis Networks. All rights reserved. For licensing inquiries, contact license@apisnetworks.com