REQUEST PASSWORD RESET

RESET YOUR PASSWORD

OK
forgot password?
CANCEL
SHOW API DOCS NAV

REST API

Basics

How the API works Getting Started

Object Properties

Types Coordinates Colors Components Generic Components Line Groups Areas Icons Images Widgets

Meta Data

Adding Displaying Searching Selectors

API Endpoints

Documents

List Get Details Get Content Set Content Create Empty Add Collaborator Change Title Clone Delete

Objects

List Get By Id Get By Selector Create Update Update Multiple Update By Selector Delete

Folders

Create List Change Title Delete

Embeds

Create Static Embed Delete Static Embed Enable Live Embed

Auto Diagram Creation

Request Format Margins, Paddings & Co Components Connections Arrows Groups Nested Groups Tiers Labels Styling Meta Data

IDF Property Reference

Common Properties Component Generic Component Group Connection Image Frame

Image Creation

From Document From CSV or JSON

API Key

Create List Get Details Delete

Enterprise

Requirements

Executable Image Server Operating System Hardware Database Load Balancer

Setup & Deployment

Installation Configuration Deployment

Authentication

Types Steps Configuration

SSO Integration

How it works Login Form Enabling Webhook Auth Authenticating Users Permissioning Document Access Permissioning Access to Embeds

Azure Active Directory

Configuration iFrame integration LocalStorage Passing Token …via Query String …via Post Message Key Parameter

Groups & Permissions

Introduction Key Concepts Relationships Installation Getting Started Managing Groups Managing Users Assigning Groups to Docs Assigning Groups to Embeds

Server-Side Rendering

How it works Caveats Installation Configuration Stability

Service & Logging

Installation Interacting with the Service Uninstalling Running Multiple Instances Logging to File Logging to Event-Viewer

Arcentry Development

Setup

Prerequisites Installation ...Frontend ...Backend Database Setup Configuration Starting the Server Accessing the App

Architecture Overview

State

Structure Manipulation

Backend & Server

Request Processing Access Control Publish Subscribe Building Executable External Dependencies Testing

Frontend Overview

Structure Object Graph

Frontend Rendering

2D Drawing When does drawing happen?

Arcentry Enterprise - Requirements

Arcentry Enterprise is the commercial on-premise version of Arcentry. You can learn more about it here or contact us at info@arcentry.com.

What does the executable do?

Each Enterprise instance performs the following functions:

  • Serving the app: Arcentry Enterprise runs an HTTP server for static assets such as JS and CSS files, images, icons etc. Static assets are served under the /app path.
  • Internal API: HTTP endpoints for Arcentry's internal calls for document creation, changes etc. These endpoints reside under /api/
  • External API: HTTP endpoints for external API interactions. These reside under /api/v1
  • Websocket Server: Arcentry runs a WebSocket server for realtime updates to documents. This server runs on top of the existing HTTP server, so no additional ports are necessary.

You can enable and disable each of these in the `arcentry-conf.yml` file shipped with each instance.

Image Server

The server-side rendering of Arcentry diagrams used by the api/v1/image/from-document/ and /api/v1/image/create-from-diagram endpoints is provided by a separate process, the arc-image-server. You can find more about it here.

Operating System

Arcentry Enterprise is usually run in production on Linux Servers. It supports Ubuntu, Alpine, Red Hat, OpenSUSE, Fedora Server, CentOS, Debian and a number of smaller distributions. Mac and Windows executables are available for development and production as well.

Hardware

For production, we recommend a dedicated dual-core machine per process, with at least 1.6 Ghz/Core and 4GB of RAM, e.g. AWS t2.medium, Azure Standard_B2s, or Google Cloud n2-standard-2.

Database

Arcentry requires a Postgres Database > v9.0.0. The database is used for both long term storage as well as inter-process communication. This makes it easy to scale Arcentry Enterprise instances by simply connecting them to the same database.

Load Balancer

We recommend fronting your Arcentry Enterprise instances with a load balancer such as NginX or Apache for local deployments or AWS ELB or Azure Load Balancer for Cloud deployments. This load balancer can handle SSL termination, traffic distribution, and health checks for the underlying instances.