Found 418 results for "docs api functions"

The search executed in 0.002089854 seconds. That's fast.

Gitana / 3.2 / Guide / Guide / Docker / Kits / Quickstart

Quickstart The Quickstart kit defines the following services: ui api mongodb elasticsearch These are connected like this: Running Use the following commands: docker-compose build --force-rm docker-compose up And then open a browser to: http://localhost To access the API directly: https://localhost:8080 docker-compose.yml version: "2" services: ui: build: ./ui networks: - cloudcms depends_on: - api env_file: - ./ui/ui.env ports: - "80:80" api:

Score: 1.3794644

Gitana / 4.0 / Self Managed / Kits / Quickstart

Quickstart The Quickstart kit defines the following services: ui api mongodb elasticsearch These are connected like this: Running Use the following commands: docker-compose build --force-rm docker-compose up And then open a browser to: http://localhost To access the API directly: https://localhost:8080 docker-compose.yml version: "2" services: ui: build: ./ui networks: - cloudcms depends_on: - api env_file: - ./ui/ui.env ports: - "80:80" api:

Score: 1.3794644

API Max Heap recommendation

What is the recommended Xmx value for running the API service? The 2GB setting on the On-Premise "quickstart" distribution is a default for development usage. In production, we recommend putting as much memory as you can. Essentially, the API should use as much memory as is allocated to the API docker container. We usually ask customers to consider an M class large instance type (something on the order of 7.5GB of RAM per API). The UI can use considerably less. For the UI, a 2GB allocation is fi

Score: 1.3661909

Gitana / 4.0 / Developers / Frameworks / Postman

Postman Guide and References for connectivity to Cloud CMS Connecting to Cloud CMS If you want to test out the Cloud CMS API using Postman or another HTTP client, you'll first have to obtain an authentication token First, ensure you have API Keys configured for your project (this is done by default for the sample project). You can find these by going to Manage Project and clicking API Keys in the left hand menu. Next, we will request the token. In Postman, use the 'Basic Auth' type under Authori

Score: 1.3455857

Gitana / 4.0 / Developers / Frameworks / cURL

cURL Guide and References for connectivity to Cloud CMS Connecting to Cloud CMS From a command prompt, the curl command can be used to execute API calls to Cloud CMS. Connecting to the Cloud CMS API requires API Keys from your Cloud CMS project. This is done by default for the sample project. You can find these by going to Manage Project and clicking API Keys in the left hand menu. Several examples of using curl are available in our Gitana SDK For example, reading a node can be done with the fol

Score: 1.3324957

Cloud CMS Architecture

Cloud CMS has two clusters that we run for customers who host apps with us. One cluster is for the "app server" tier (*.cloudcms.net) and the other is the "API" tier (api.cloudcms.com). The app server cluster consists of Node.js servers, and the API is a Java-backend that is stateless and implements the full REST API: As such, the API doesn't manage connections directly. Any invocation to it is a one-shot where each request contains everything needed to assert the user's identity and proceed wit

Score: 1.3312442

My UI modules aren't deploying. What should I check?

If you're running an on-premise installation of Cloud CMS and are unable to deploy UI modules via the main user interface, here are a few tips and pointers. Things to consider: 1. When you click on the "Deploy Module" option, your a URL connection is made from the UI server back to the API server. Specifically, it invokes a POST to the route: /oneteam/modules/deploy Check your API side logs or any firewalls or proxies along the way to make sure that an API server receives this call. For example,

Score: 1.320687

Gitana / 4.0 / Self Managed / Configuration / UI Server

UI Server The Cloud CMS UI Server is a Node.js application that provides the editorial experience for Cloud CMS. It communicates with the Cloud CMS API via HTTP/HTTPS API calls and is built to be very extensible. Developers and system integrators can extend the Cloud CMS UI through the deployment of UI modules. Environment File (.env) The Cloud CMS UI is primarily configured via a series of environment variables. These environment variables are detected by the Node.js application at startup and

Score: 1.3178349

Proxy API calls

Whenever a resulting URL looks something like: https://api.cloudcms.com/repositories/f0fb4efd3de07c54420a/branches/9bcdbfea8f2d900f0387/nodes//attachments/thumb.jpg It works great as an API URL but not necessarily as one that can be resolved by the end user's browser. In a typical Node.js-based architecture, you have the User’s browser Node.js application server Cloud CMS backend API The URL generated above is the URL directly to the resource in the backend API. What you really would pre

Score: 1.307065

Gitana / 3.2 / Guide / Guide / Docker / Kits

Kits Cloud CMS ships a number of pre-built kits containing Docker configuration files to help you get start. These kits are built from customer feedback to provide the most commonly requested scenarios. They can be used straight away or at the very least can serve as a useful reference. To download the Cloud CMS Docker Kits, please visit our Docker download page. Kits All of the Docker kits utilize Docker and Docker Compose. In each kit, you'll find a docker-compose.yml file which describes the

Score: 1.3044461

Gitana / 4.0 / Self Managed / Kits / Overview

Kits Cloud CMS ships a number of pre-built kits containing Docker configuration files to help you get start. These kits are built from customer feedback to provide the most commonly requested scenarios. They can be used straight away or at the very least can serve as a useful reference. To download the Cloud CMS Docker Kits, please visit our Docker download page. Kits All of the Docker kits utilize Docker and Docker Compose. In each kit, you'll find a docker-compose.yml file which describes the

Score: 1.3044461

Gitana / 3.2 / Guide / Guide / Docker / Container Services / Amazon ECS

Amazon ECS Amazon Elastic Container Service (ECS) is a fully managed container orchestration service that helps you to more efficiently deploy, manage, and scale containerized applications. It deeply integrates with the AWS environment to provide an easy-to-use solution for running container workloads within Amazon Web Services. For more information on Amazon ECS, please visit https://aws.amazon.com/ecs. Gitana SDK The code and configuration provided here references the samples provided in the G

Score: 1.3028146

Supporting large binary files

Cloud CMS offers a few different ways for you to store files - including storing them in S3 (recommended) or even on a local partition (such as an NFS mount). In our SaaS offering, everything is stored in S3 automatically and when you install on-premise, you can configure this to your preference. See this documentation page under Binary Storage: https://www.cloudcms.com/documentation/docker/configuration/api-server.html We definitely can handle large binary files in the 10's or 100's of megabyte

Score: 1.2947103

Gitana / 3.2 / Guide / Guide / Docker / Configuration / UI Server

UI Server The Cloud CMS UI Server is a Node.js application that provides the editorial experience for Cloud CMS. It communicates with the Cloud CMS API via HTTP/HTTPS API calls and is built to be very extensible. Developers and system integrators can extend the Cloud CMS UI through the deployment of UI modules. Environment File (.env) The Cloud CMS UI is primarily configured via a series of environment variables. These environment variables are detected by the Node.js application at startup and

Score: 1.2851827

Gitana / 3.2 / Guide / Guide / Docker

Docker Cloud CMS offers the option to run development and production installations of its software on-premise or within a virtual private cloud. This option is available to subscription customers and can be utilized in both a development and production capacity. The actual installation and management of the various services involved in a full-scale production-ready Cloud CMS deployment is facilitated greatly through the use of Docker. Docker provides a way for all of the various tiers to be enca

Score: 1.2805152

Gitana / 3.2 / Guide / Guide / Deployment / Deployment Handlers / Remote Deployment Handler

Remote Deployment Handler Handles the deployment of one or more Deployment Packages to a remote Deployment Receiver. Where: url is the URL of the target Cloud CMS API server receiverId is the ID of the receiver on the target Cloud CMS API server In addition, you should provide the API keys of the user who the Remote Deployment Handler will authenticate as. clientKey clientSecret username password Configuration { "url": "{url}", "clientKey": "{clientKey}", "clientSecret": "{clientSecr

Score: 1.2787129

Gitana / 4.0 / Data Engine / Deployment / Deployment Handlers / Remote Deployment Handler

Remote Deployment Handler Handles the deployment of one or more Deployment Packages to a remote Deployment Receiver. Where: url is the URL of the target Cloud CMS API server receiverId is the ID of the receiver on the target Cloud CMS API server In addition, you should provide the API keys of the user who the Remote Deployment Handler will authenticate as. clientKey clientSecret username password Configuration { "url": "{url}", "clientKey": "{clientKey}", "clientSecret": "{clientSecr

Score: 1.2787129

Recommended Cloud CMS architecture

In general, we recommend a three-tier architecture (browser -> app server -> API) for any applications you build. This would be our recommendation whether you're using Cloud CMS or anyone else. There are a few good reasons: The browser is an insecure runtime. Exposing any API keys within the browser is a very big security hole. Even exposing credentials within the browser (such as within a cookie) for the sake of working around this is also not recommended since hackers can siphon off the creden

Score: 1.2717294

Gitana / 3.2 / Guide / Guide / Docker / Container Services / Kubernetes

Kubernetes Kubernetes, also known as K8s, is an open-source system for automating the deployment, scaling, and management of containerized applications. Kubernetes is open-source and adaptable to a number of cloud providers including Amazon, Google, Azure and others. It allows you to express your infrastructure configuration in such a way as to take advantage of on-premises and a diversity of hybrid and public cloud infrastructures. For information on Kubernetes, please visit https://kubernetes.

Score: 1.2709287

Gitana / 4.0 / Self Managed / Docker / Overview

Docker Cloud CMS offers the option to run development and production installations of its software on-premise or within a virtual private cloud. This option is available to subscription customers and can be utilized in both a development and production capacity. The actual installation and management of the various services involved in a full-scale production-ready Cloud CMS deployment is facilitated greatly through the use of Docker. Docker provides a way for all of the various tiers to be enca

Score: 1.2682663

Gitana / 3.2 / Guide / Guide / Application Server / Authentication / Providers / GitHub

GitHub Cloud CMS provides integrated authentication and single-sign-on (SSO) with GitHub. This page describes the authentication provider available for the Cloud CMS Application Server that enables your mobile or web applications as well as the Cloud CMS user interface or API to authenticate against GitHub. For more information on Authentication within the App Server, see App Server Authentication / SSO. GitHub API Keys You will need to configure a GitHub application and have the following infor

Score: 1.2668859

Gitana / 3.2 / Guide / Guide / Application Server / Authentication / Providers / Google

Google Cloud CMS provides integrated authentication and single-sign-on (SSO) with Google. This page describes the authentication provider available for the Cloud CMS Application Server that enables your mobile or web applications as well as the Cloud CMS user interface or API to authenticate against Google. For more information on Authentication within the App Server, see App Server Authentication / SSO. Google API Keys You will need to configure a Google application and have the following infor

Score: 1.2668859

Gitana / 3.2 / Guide / Guide / Application Server / Authentication / Providers / Twitter

Twitter Cloud CMS provides integrated authentication and single-sign-on (SSO) with Twitter. This page describes the authentication provider available for the Cloud CMS Application Server that enables your mobile or web applications as well as the Cloud CMS user interface or API to authenticate against Twitter. For more information on Authentication within the App Server, see App Server Authentication / SSO. Twitter API Keys You will need to configure a Twitter application and have the following

Score: 1.2668859

Gitana / 4.0 / Developers / Application Server / Authentication / Providers / GitHub

GitHub Cloud CMS provides integrated authentication and single-sign-on (SSO) with GitHub. This page describes the authentication provider available for the Cloud CMS Application Server that enables your mobile or web applications as well as the Cloud CMS user interface or API to authenticate against GitHub. For more information on Authentication within the App Server, see App Server Authentication / SSO. GitHub API Keys You will need to configure a GitHub application and have the following infor

Score: 1.2668859

Gitana / 4.0 / Developers / Application Server / Authentication / Providers / Google

Google Cloud CMS provides integrated authentication and single-sign-on (SSO) with Google. This page describes the authentication provider available for the Cloud CMS Application Server that enables your mobile or web applications as well as the Cloud CMS user interface or API to authenticate against Google. For more information on Authentication within the App Server, see App Server Authentication / SSO. Google API Keys You will need to configure a Google application and have the following infor

Score: 1.2668859