The Digital Telepresence Platform core implementing user account management, authentication, search, global directory, and other platform-wide services. https://digitaltelepresence.com/
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
Rob Colbert 825be92908 v0.5.5 9 months ago
.vscode Merge branch 'develop' of git.digitaltelepresence.com:digital-telepresence/dtp-base into develop 9 months ago
app Merge branch 'develop' of git.digitaltelepresence.com:digital-telepresence/dtp-base into develop 9 months ago
client Merge branch 'develop' of git.digitaltelepresence.com:digital-telepresence/dtp-base into develop 9 months ago
config backport Unified Feed from Sites to Base 9 months ago
docker Docker integration; cleanup of config file names 2 years ago
docs Merge branch 'develop' of git.digitaltelepresence.com:digital-telepresence/dtp-base into develop 9 months ago
lib Merge branch 'develop' of git.digitaltelepresence.com:digital-telepresence/dtp-base into develop 9 months ago
ssl small updates 1 year ago
static Docker integration; cleanup of config file names 2 years ago
supervisord migrate to the use of dtp-logan-api 9 months ago
.dockerignore Docker integration; cleanup of config file names 2 years ago
.env.default migrate to the use of dtp-logan-api 9 months ago
.env.docker.default cleanup 9 months ago
.gitignore added changing site icon and small touchups 1 year ago
.jshintrc migrate to the use of dtp-logan-api 9 months ago
Dockerfile Docker integration; cleanup of config file names 2 years ago
LICENSE catching up with progress from Sites and Soapbox 2 years ago
NOTES.md catching up with progress from Sites and Soapbox 2 years ago
README.md Merge branch 'develop' of git.digitaltelepresence.com:digital-telepresence/dtp-base into develop 10 months ago
deploy integrate updates from LibertyLinks engine enhancements; new features for blog 2 years ago
docker-build Docker integration; cleanup of config file names 2 years ago
docker-clean Docker integration; cleanup of config file names 2 years ago
docker-compose.yml Docker integration; cleanup of config file names 2 years ago
docker-console Docker integration; cleanup of config file names 2 years ago
docker-proxy Docker integration; cleanup of config file names 2 years ago
dtp-core.code-workspace renamed for core 2 years ago
dtp-media-engine.js more component definition updates 9 months ago
dtp-webapp-cli.js Merge branch 'develop' of git.digitaltelepresence.com:digital-telepresence/dtp-base into develop 9 months ago
dtp-webapp.js Merge branch 'develop' of git.digitaltelepresence.com:digital-telepresence/dtp-base into develop 9 months ago
gulpfile.js small updates 1 year ago
package.json v0.5.5 9 months ago
push build and deployment automation 2 years ago
release catching up with progress from Sites and Soapbox 2 years ago
restart-production environment control scripts updated 1 year ago
start-local Merge branch 'develop' of git.digitaltelepresence.com:digital-telepresence/dtp-base into develop 9 months ago
start-production Merge branch 'develop' of git.digitaltelepresence.com:digital-telepresence/dtp-base into develop 9 months ago
stop-production Merge branch 'develop' of git.digitaltelepresence.com:digital-telepresence/dtp-base into develop 9 months ago
update-deps.js more component definition updates 9 months ago
yarn.lock Logan API updated 9 months ago

README.md

Digital Telepresence Platform Core

DTP Core implements user account management, platform search, the platform directory, and the platform menu.

Requirements

The only qualified operated system for hosting a DTP Core suite is Ubuntu 20.04 LTS. It is acceptable to run it in a virtual machine for development and testing, but it should be run as close to bare metal as can be had for production environments.

Host Preparation

The following commands must be exeucted on any host expected to run DTP Framework applications.

apt -y update && apt -y upgrade
apt -y install linux-headers-generic linux-headers-virtual linux-image-virtual linux-virtual
apt -y install build-essential ffmpeg supervisor

Install Data Tier Components

You will need MongoDB and MinIO installed and running before you can start DTP Core web services.

  1. Install MongoDB
  2. Install MinIO

Install redis:

sudo apt-get install redis

Install Node Version Manager (NVM) and Node.js

wget -qO- https://raw.githubusercontent.com/nvm-sh/nvm/v0.39.1/install.sh | bash

Resolve Global Node Dependencies

Yarn, Gulp, and Forever are required to be installed globally. This should be done once per developer workstation and repeated when updates are required.

nvm install --lts
npm install -g yarn gulp forever

Preparing a Fresh Install

Clone the DTP Base Repository

cd ~/live
git clone [email protected]:digital-telepresence/dtp-base.git

Install Required Dependencies

cd ~/live/dtp-base
yarn

Generate SSL/TLS Certificate

cd ~/live/dtp-base/ssl
./mkcert

Environment Configuration

On a new host or host image, copy .env.default to .env and edit it as necessary.

For password salt and service passwords, the uuidgen tool may be useful to help generate hard-to-guess passwords for use in a development environment. Something more sophisticated than a UUID should be used in production.

Starting DTP Core In Development Mode

  1. Make sure NODE_ENV is set to local
  2. Run ./start-local in a VS Code terminal, then rename that terminal to services.
  3. In a new VS Code terminal, run gulp and rename that terminal gulp.
  4. Open https://localhost:3000 in your web browser.

You can now make changes to program source code, and the environment will automatically respond, build, pack, and re-load things as needed depending on what you did and what's open/running.

DTP Core is a multi-tier web hosting engine built on:

Production Environment Information

The only qualified operated system for hosting a DTP Base suite is Ubuntu 20.04 LTS. It is acceptable to run it in a virtual machine for development and testing, but it should be run as close to bare metal as possible in production environments.

It's impossible to give 100% generic advice here, but it all depends on how large your audience is and how much they use your website. Larger, more active audiences will require a different kind of production server deployment than smaller and less active audiences.

Generally, it's possible to stack all components on one host and operate a fast site for small-to-medium audiences. The size of the host may vary, but it's possible to keep the system stacked and handle quite a large audience.

Beyond a point, you'll need to start isolating services away from each other. Storage will want it's own system(s), MongoDB will want it's own systems (plural), Redis will want it's own system(s), and the Node.js components can each start to want their own system(s).

Once you start scaling horizontally, the host requirements change a little. You will need two networks and network interfaces per host. The production network to handle public requests; and a management network for handling IPC and data-sharing among the hosts themselves.

Some useful links for learning more about hosting MinIO:

Redis simply has many different documents to describe it's many different features and their requirements. I'd like to give you a summary page link, but it doesn't exist. This is that summary page. These are those links.

Software License

DTP Core and the DTP Phoenix Engine and framework are licensed under the Apache 2.0 open source software license. See LICENSE for more information.