61 captures
11 Jul 2015 - 04 Oct 2025
Oct NOV Dec
21
2018 2019 2020
success
fail

About this capture

COLLECTED BY

Collection: Common Crawl

Web crawl data from Common Crawl.
TIMESTAMPS

The Wayback Machine - http://web.archive.org/web/20191121005701/https://resources.count.ly/docs/installing-countly-server
 

Countly Documentation


Countly Home
Support Forum
Slack Channel
Countly API

Countly Resources

Here you'll find comprehensive guides to help you start working with Countly as quickly as possible.



HomeGuidesCountly APIReferenceChangelogDiscussionsPage Not FoundSearch{{ state.current().meta.title }}API Logs
HomeGuidesCountly API


discard

Search results for "{{ search.query }}"

No results found for "{{search.query}}". 


Documentation {{result.projectName ? 'in ' + result.projectName : ''}}


{{result._method}}Reference {{result.projectName ? 'in ' + result.projectName : ''}}


Changelog {{result.projectName ? 'in ' + result.projectName : ''}}


Discussions {{result.projectName ? 'in ' + result.projectName : ''}}


Page {{result.projectName ? 'in ' + result.projectName : ''}}
View All Results




Reference Documents

 Getting started
 Features at a glance
 System requirements
 Product roadmap
 Server API reference
 Countly performance
 Open source components
 Translating Countly
 Contributing to Countly
 Rebranding Enterprise Edition
 Release notes
 Contributors
 Glossary

User Guides

 User's guide
 Best practices
 Custom events
 Drill (Advanced segmentation)
 Crash reporting
 Crash symbolication
 User profiles
 Flows
 Dashboards
 A/B Testing
 Push notifications
 Cohorts (behavioral segmentation)
 Funnels
 Remote config
 Attribution analytics
 Attribution campaign types
 Web analytics
 Views and heatmaps
 Countly Assistant
 Revenue analytics
 Formulas
 Alerts and reports
 Active Directory integration
 Data migration
 Compliance Hub
 Ratings & Feedbacks
 Two factor authentication
 JIRA integration

Official SDKs

 Downloading & Installing SDKs
 SDK development guide
 iOS, watchOS, tvOS & macOS
 Android SDK
 Windows SDK
 Web analytics (JavaScript)
 Phonegap, Icenium & Meteor
 IoT devices (Python)
 NodeJS SDK
 React Native (Bridge)
 React Native (unmaintained)
 Xamarin.Forms (iOS)
 Xamarin (Android)
 Xamarin.iOS
 Unity
 Java

Installation & Configuration

 Installing Countly server
 Upgrading Countly server
 Deployment scenarios
 Docker & Kubernetes
 High availability deployment (Enterprise Edition)
 Backing up Countly server
 Configuring Countly
 Countly command line
 Configuring HTTPS and SSL
 Installing Let's Encrypt for HTTPS
 Securing MongoDB
 Cross device reporting
 Troubleshooting

FAQ

 General FAQ
 Installation FAQ
 Licencing FAQ
 Technical FAQ
 Security & privacy FAQ
 User Profiles FAQ
 Web analytics FAQ
 Attribution analytics FAQ
 Crash reporting FAQ
 Push notifications FAQ
 iOS SDK FAQ
 Android SDK FAQ

Plugin Development

 Introduction
 Plugin structure
 Plugin API side
 Frontend server side files
 Frontend (browser) files
 Creating UI view
 Extending or modifying modules
 Shared configurations
 Logging
 Document splitting
 Debugging Countly servers
 Dashboard widgets
 Email reports

Database Schema

 Introduction
 MongoDB basics
 countly.apps
 countly.app_crashes{appID}
 countly.app_crashgroups{appID}
 countly.app_crashusers{appID}
 countly.app_users{appID}
 countly.app_viewdata{appID}
 countly.app_views{appID}
 countly.browser
 countly.campaigns
 countly.carriers
 countly.cities
 countly.crashdata
 countly.crash_share
 countly.density
 countly.device_details
 countly.devices
 countly.events
 countly.events{ID}
 countly.funnels
 countly.graph_notes
 countly.geos
 countly.jobs
 countly.langs
 countly.logs{appID}
 countly.members
 countly.messages
 countly_drill.drill_events{ID}
 countly.plugins
 countly.reports
 countly.sources
 countly.systemlogs
 countly.users
 countly.timesofday{appID}
 countly.data_migrations
 countly.web_feedback_widgets_{appID}
 countly.feedback{appID}
 countly.alerts
 countly.alerts_data
 countly.dashboards
 countly.widgets
 countly_out.remoteconfig_parameters{appID}
 countly_out.remoteconfig_conditions{appID}
 countly_out.ab_testing_experiments{appID}
 countly.top_events

Support

REST API Reference

Introduction

Core API

get/i
get/api-key
get/o/users/all
get/o/users/me
get/o/apps/all
get/o/apps/mine
get/o/apps/details
get/o?method=locations
get/o?method=sessions
get/o?method=users
get/o?method=devices
get/o?method=device_details
get/o?method=carriers
get/o?method=app_versions
get/o?method=cities
get/o?method=events
get/o?method=get_events
get/o?method=get_period_obj
get/o?method=top_events
get/o?method=total_users
get/o/analytics/dashboard
get/o/analytics/countries
get/o/analytics/sessions
get/o/analytics/metric
get/o/analytics/tops
get/o/analytics/loyalty
get/o/analytics/frequency
get/o/analytics/durations
get/o/ping
get/i/users/create
get/i/users/update
get/i/users/delete
get/i/users/deleteOwnAccount
get/i/apps/create
get/i/apps/update
get/i/apps/reset
get/i/apps/delete
post/i/bulk
get/i/app_users/create
get/i/app_users/update
get/i/app_users/delete
get/i/app_users/export
get/i/app_users/deleteExport/:filename
get/o/app_users/download/:filename

Drill API

get/o?method=segmentation
get/o?method=segmentation_users
get/o?method=segmentation_meta
get/o?method=segmentation_big_meta
get/o?method=drill_bookmarks
get/i/drill/add_bookmark
get/i/drill/delete_bookmark

Push API

post/i/pushes/create
post/i/pushes/prepare
get/i/pushes/message
get/i/pushes/delete
get/o/pushes/all
get/i/pushes/active
post/i/pushes/push

Attribution API

get/o/campaign
get/o/campaign?data
get/o/campaign?camp_id
get/o/campaign?getTable
get/i/campaign/create
get/i/campaign/update
get/i/campaign/delete
get/i/campaign/hide
get/i/campaign/show

Live API

get/o?method=live
get/o?method=live_graph

User Profiles API

get/o?method=user_details&uid
get/o?method=user_details

Funnels API

get/o?method=funnel
get/o?method=get_funnels
get/i/funnels/add
get/i/funnels/delete

DBViewer API

get/o/db
get/o/db?dbs=:db&collection=:collection
get/o/db?dbs=:db&collection=:collection&document=:document

Compare API

get/o/compare/events
get/o/compare/apps

Cohorts API

get/o?method=cohort
get/o?method=get_cohorts
get/o?method=get_cohort_list
get/o?method=cohortdata
get/i/cohorts/add
get/i/cohorts/edit
get/i/cohorts/delete

Data Migration

get/o/datamigration/getmyimports
get/o/datamigration/getmyexports
get/o/datamigration/getstatus
get/o/datamigration/validateconnection
get/i/datamigration/sendexport
get/i/datamigration/export
get/i/datamigration/stop_export
get/i/datamigration/delete_import
get/i/datamigration/delete_export
get/i/datamigration/delete_all
get/i/datamigration/import
get/i/datamigration/report_import

Feedback plugin

get/o?method=star
get/i/feedback/widgets/create
get/i/feedback/widgets/remove
get/i/feedback/widgets/edit
get/o/feedback/data
get/o/feedback/multiple-widgets-by-id
get/o/feedback/widgets
get/o/feedback/widget

Other Plugins

get/o/slipping
get/o?method=retention

Export API

get/o/export/db

Whitelabeling

get/o/whitelabeling/data
post/i/whitelabeling/updateform

Alerts API

get/i/alert/save
get/i/alert/delete
get/i/alert/status
get/o/alert/list

Flows API

get/o/flows

System Utility API

get/o/system/overall
get/o/system/memory
get/o/system/disks
get/o/system/cpu
get/o/system/database
get/o/system/healthcheck
get/o/system/dbcheck
get/o/system/plugins
get/o/system/version

Dashboards API

get/o/dashboards/all
get/o/dashboards
get/i/dashboards/create
get/i/dashboards/update
get/i/dashboards/delete
get/o/dashboards/widget
get/i/dashboards/add-widget
get/i/dashboards/update-widget
get/i/dashboards/remove-widget

Token manager

get/o/token/check
get/o/token/list
get/i/token/create
get/i/token/delete

Remote Config API

get/o/sdk?method=fetch_remote_config
get/o?method=remote-config
get/i/remote-config/add-parameter
get/i/remote-config/update-parameter
get/i/remote-config/remove-parameter
get/i/remote-config/add-condition
get/i/remote-config/update-condition
get/i/remote-config/remove-condition

A/B Testing API

get/o?method=ab-testing
get/o/ab-testing/check-models
get/o/ab-testing/experiment
get/o/ab-testing/experiment-detail
get/i/ab-testing/add-experiment
get/i/ab-testing/update-experiment
get/i/ab-testing/remove-experiment
get/i/ab-testing/start-experiment
get/i/ab-testing/stop-experiment
get/i/ab-testing/update-experiment-position

Notes API

get/i/notes/save
get/i/notes/delete
get/o?method=notes
get/o/notes

Tasks

get/i/tasks/delete
get/i/tasks/edit
get/i/tasks/name
get/i/tasks/update
get/o/tasks/all
get/o/tasks/check
get/o/tasks/list
get/o/tasks/task

Groups

get/o/groups
get/o/groups/group-users
get/i/groups/create
get/i/groups/update
get/i/groups/delete
get/i/groups/save-user-groups



Installing Countly server

Suggest Edits


Requirements


Countly can be installed on a Linux server (see system requirements for more information). By default, Node.js (the web server Countly needs) will run on port 80 or 443 (for HTTPS), so make sure those ports are free and not blocked (as in Amazon AWS case)


Ubuntu flavors  


Ubuntu flavors (eg. Kubuntu, Lubuntu) are not supported.
 


Method 1: One liner installation


The following command will download and install Countly Community Edition on your UbuntuorCentOS server. 




Latest Stable

Development
 

sudo su - 
wget -qO- http://c.ly/install | bash
sudo su -
wget -qO- http://c.ly/install | bash -s dev



Method 2: One click installation via Digital Ocean


If you have a Digital Ocean account and want to install Countly Community Edition, create a droplet using this link. Upon selecting a plan and a datacenter region, your Countly instance is ready to go!

Method 3: Downloading via Github or package installation


As an alternative method, you can download Countly Community Edition via Github: 


Download main branch (recommended for technology preview installations)
Download latest release (recommended for stable release installations)

Note: Enterprise Editions source code is not available for public and is downloaded from Enterprise Edition customer private repository. However, installation procedures for both editions are the same, as follows.

Extract Countly package to a directly of your taste (e.g under /usr) - do not use /root folder for this purpose. Then, fire the easy installation script that comes with Countly, which will work both for Ubuntu or RHEL/CentOS:




Shell
 

sudo su - 
cd COUNTLY_INSTALLATION_DIRECTORY/bin
bash countly.install.sh



Disable SELinux  


Disable SELinux on Red Hat or CentOS if it's enabled. Countly may not work on a server where SELinux is enabled. In order to disable SELinux, run "setenforce 0".
 


Installation will take between 10-15 minutes. Using your browser, go to http://YOUR_SERVER_IP_OR_DOMAIN in order to create your admin account and login to your dashboard. Also do not forget to download client SDKs.


64-bit support only  


Due to MongoDB and 32-bit limitations, we only support new installations on 64 bit servers.
 


Running Countly from a subdirectory  


It is also possible to run Countly from a subdirectory. Follow those instructions to configure this.
 


Method 4: Installation via Docker


We provide various Docker images for Countly Community Edition & Countly Enterprise Edition suitable for both: standard Docker installations & Kubernetes clusters. Please refer to Docker & Kubernetes page for further information.

Configure DNS


While Countly server will work without a DNS, it's suggested that you assign a DNS A record to your server, so you do not have to memorize IP address, like countly.yourserver.com. 

Configure email delivery


Due to potential spam issues, you need make sure that you configure your DNS records (explained below), so that emails sent from Countly (e.g when you add a new user, or daily/weekly email reports) can be sent and not caught by SPAM preventions.

Here are a few important things you should check first:


Make sure your ISP have a reverse DNS record entered to associate the domain names and IP addresses you send mail from. Test your Reverse PTR record here. If your ISP does not enter the proper reverse DNS pointer record, it's very unlikely any of your email will be delivered.

Is your domain's SPF record correct? Test your SPF record here. Note that TXT is the correct official record type for SPF.

Is your domain's DKIM record correct? This will significantly improve email deliverability. Test your DKIM record here.

If you run your own mail server, check to make sure the IPs of your mail server are not on any email blacklists. Also verify that it is definitely sending a fully-qualified hostname that resolves in DNS in its HELO message. If not, this will cause your email to be rejected by many mail services.


We highly recommend you send a test emailtomail-tester.com to verify that all the above is working correctly.

Using a 3rd party email server


If you want to use a 3rd party email server and instead not use Countly server's email abilities, do the following: 


(一)Rename this file (/extend/mail.example.js in your Countly directory) to /extend/mail.js.
(二)Add your email server information. An example is provided below: 




JavaScript
 

module.exports = function(mail){
    //define this if you need to send email from some third party service
    mail.smtpTransport = nodemailer.createTransport(smtpTransport({
        host: "example-mailserver-host.com",
        secureConnection: true,
        port: 2525,
        auth: {
            user: "your-mailserver-username",
            pass: "your-mailserver-password"
        }
    }));



Configure monitoring for your server


When your server has a problem (e.g lack of enough RAM, lack of swap space, running out of disk etc), chances are Linux kernel will kill some of the processes, or Countly won't work properly. In order to make sure you have a healthy and stable server, we suggest that you use one of monitoring and alerting solutions like Server Density, NagiosorNew Relic.

Making Countly more secure


We have a list of security & privacy recommendations, together with guidelines on how to ensure a secure deployment. You can read it here.



Table of Contents
{{ node.data[1] }}
{{ node.data[1] }}

Table of Contents
{{ node.data[1] }}
{{ node.data[1] }}

Installing Countly server


Suggested Edits are limited on API Reference Pages

You can only suggest edits to Markdown body content, but not to the API spec.