Skip to content

Commit

Permalink
Updated TOC in README.md.
Browse files Browse the repository at this point in the history
  • Loading branch information
jhuckaby committed May 13, 2018
1 parent 1d92600 commit 16a61ef
Showing 1 changed file with 152 additions and 47 deletions.
199 changes: 152 additions & 47 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,53 +22,158 @@

## Table of Contents

- **[Installation](#installation)**
- **[Setup](#setup)**
- [Single Server](#single-server)
- [Single Master with Slaves](#single-master-with-slaves)
- [Multi-Server Cluster](#multi-server-cluster)
- **[Configuration](#configuration)**
- [Basics](#basics)
- [Storage Configuration](#storage-configuration)
- [Web Server Configuration](#web-server-configuration)
- [User Configuration](#user-configuration)
- [Email Configuration](#email-configuration)
- **[Web UI](#web-ui)**
- [Home Tab](#home-tab)
- [Schedule Tab](#schedule-tab)
- [Completed Jobs Tab](#completed-jobs-tab)
- [Job Details Tab](#job-details-tab)
- [My Account Tab](#my-account-tab)
- [Administration Tab](#administration-tab)
- **[Plugins](#plugins)**
- [Writing Plugins](#writing-plugins)
- [Sample Node Plugin](#sample-node-plugin)
- [Sample Perl Plugin](#sample-perl-plugin)
- [Sample PHP Plugin](#sample-php-plugin)
- [Built-in Shell Plugin](#built-in-shell-plugin)
- **[Command Line](#command-line)**
- [Starting and Stopping](#starting-and-stopping)
- [Storage Maintenance](#storage-maintenance)
- [Recover Admin Access](#recover-admin-access)
- [Server Startup](#server-startup)
- [Upgrading Cronicle](#upgrading-cronicle)
- **[Inner Workings](#inner-workings)**
- [Storage](#storage)
- [Logs](#logs)
- [Keeping Time](#keeping-time)
- [Master Server Failover](#master-server-failover)
- **[API Reference](#api-reference)**
- [JSON REST API](#json-rest-api)
- [API Keys](#api-keys)
- [Standard Response Format](#standard-response-format)
- [API Calls](#api-calls)
- [Event Data Format](#event-data-format)
- **[Development](#development)**
- [Installing Dev Tools](#installing-dev-tools)
- [Manual Installation](#manual-installation)
- [Starting in Debug Mode](#starting-in-debug-mode)
- **[Colophon](#colophon)**
- **[License](#license)**
<!-- toc -->
* [Glossary](#glossary)
- [Installation](#installation)
- [Setup](#setup)
* [Single Server](#single-server)
* [Single Master with Slaves](#single-master-with-slaves)
* [Multi-Server Cluster](#multi-server-cluster)
+ [Load Balancers](#load-balancers)
+ [Ops Notes](#ops-notes)
- [Configuration](#configuration)
* [Basics](#basics)
+ [base_app_url](#base_app_url)
+ [email_from](#email_from)
+ [smtp_hostname](#smtp_hostname)
+ [smtp_port](#smtp_port)
+ [mail_options](#mail_options)
+ [secret_key](#secret_key)
+ [log_dir](#log_dir)
+ [log_filename](#log_filename)
+ [log_columns](#log_columns)
+ [log_archive_path](#log_archive_path)
+ [copy_job_logs_to](#copy_job_logs_to)
+ [queue_dir](#queue_dir)
+ [pid_file](#pid_file)
+ [debug_level](#debug_level)
+ [maintenance](#maintenance)
+ [list_row_max](#list_row_max)
+ [job_data_expire_days](#job_data_expire_days)
+ [child_kill_timeout](#child_kill_timeout)
+ [dead_job_timeout](#dead_job_timeout)
+ [master_ping_freq](#master_ping_freq)
+ [master_ping_timeout](#master_ping_timeout)
+ [udp_broadcast_port](#udp_broadcast_port)
+ [scheduler_startup_grace](#scheduler_startup_grace)
+ [universal_web_hook](#universal_web_hook)
+ [web_hook_custom_data](#web_hook_custom_data)
+ [ssl_cert_bypass](#ssl_cert_bypass)
+ [job_memory_max](#job_memory_max)
+ [job_memory_sustain](#job_memory_sustain)
+ [job_cpu_max](#job_cpu_max)
+ [job_cpu_sustain](#job_cpu_sustain)
+ [job_env](#job_env)
+ [server_comm_use_hostnames](#server_comm_use_hostnames)
+ [web_socket_use_hostnames](#web_socket_use_hostnames)
* [Storage Configuration](#storage-configuration)
+ [Filesystem](#filesystem)
+ [Couchbase](#couchbase)
+ [Amazon S3](#amazon-s3)
* [Web Server Configuration](#web-server-configuration)
* [User Configuration](#user-configuration)
* [Email Configuration](#email-configuration)
- [Web UI](#web-ui)
* [Home Tab](#home-tab)
+ [General Stats](#general-stats)
+ [Active Jobs](#active-jobs)
+ [Upcoming Events](#upcoming-events)
* [Schedule Tab](#schedule-tab)
+ [Edit Event Tab](#edit-event-tab)
- [Event ID](#event-id)
- [Event Name](#event-name)
- [Event Enabled](#event-enabled)
- [Event Category](#event-category)
- [Event Target](#event-target)
* [Algorithm](#algorithm)
* [Multiplexing](#multiplexing)
- [Event Plugin](#event-plugin)
- [Event Timing](#event-timing)
- [Event Concurrency](#event-concurrency)
- [Event Timeout](#event-timeout)
- [Event Retries](#event-retries)
- [Event Options](#event-options)
* [Run All Mode](#run-all-mode)
* [Detached Mode](#detached-mode)
* [Allow Queued Jobs](#allow-queued-jobs)
* [Chain Reaction](#chain-reaction)
- [Event Time Machine](#event-time-machine)
- [Event Notification](#event-notification)
* [Event Web Hook](#event-web-hook)
- [Event Resource Limits](#event-resource-limits)
- [Event Notes](#event-notes)
- [Run Now](#run-now)
* [Completed Jobs Tab](#completed-jobs-tab)
+ [Event History Tab](#event-history-tab)
+ [Event Stats Tab](#event-stats-tab)
* [Job Details Tab](#job-details-tab)
* [My Account Tab](#my-account-tab)
* [Administration Tab](#administration-tab)
+ [Activity Log Tab](#activity-log-tab)
+ [API Keys Tab](#api-keys-tab)
+ [Categories Tab](#categories-tab)
+ [Plugins Tab](#plugins-tab)
- [Plugin Parameters](#plugin-parameters)
- [Advanced Plugin Options](#advanced-plugin-options)
+ [Servers Tab](#servers-tab)
- [Server Groups](#server-groups)
+ [Users Tab](#users-tab)
- [Plugins](#plugins)
* [Writing Plugins](#writing-plugins)
+ [JSON Input](#json-input)
+ [JSON Output](#json-output)
- [Reporting Progress](#reporting-progress)
- [Performance Metrics](#performance-metrics)
* [Nested Metrics](#nested-metrics)
- [Changing Notification Settings](#changing-notification-settings)
- [Chain Reaction Control](#chain-reaction-control)
* [Chain Data](#chain-data)
- [Custom Data Tables](#custom-data-tables)
- [Custom HTML Content](#custom-html-content)
- [Updating The Event](#updating-the-event)
+ [Environment Variables](#environment-variables)
* [Sample Node Plugin](#sample-node-plugin)
* [Sample Perl Plugin](#sample-perl-plugin)
* [Sample PHP Plugin](#sample-php-plugin)
* [Built-in Shell Plugin](#built-in-shell-plugin)
- [Command Line](#command-line)
* [Starting and Stopping](#starting-and-stopping)
* [Storage Maintenance](#storage-maintenance)
* [Recover Admin Access](#recover-admin-access)
* [Server Startup](#server-startup)
* [Upgrading Cronicle](#upgrading-cronicle)
* [Data Import and Export](#data-import-and-export)
* [Storage Migration Tool](#storage-migration-tool)
- [Inner Workings](#inner-workings)
* [Storage](#storage)
* [Logs](#logs)
* [Keeping Time](#keeping-time)
* [Master Server Failover](#master-server-failover)
+ [Unclean Shutdown](#unclean-shutdown)
- [API Reference](#api-reference)
* [JSON REST API](#json-rest-api)
+ [Redirects](#redirects)
* [API Keys](#api-keys)
* [Standard Response Format](#standard-response-format)
* [API Calls](#api-calls)
+ [get_schedule](#get_schedule)
+ [get_event](#get_event)
+ [create_event](#create_event)
+ [update_event](#update_event)
+ [delete_event](#delete_event)
+ [run_event](#run_event)
+ [get_job_status](#get_job_status)
+ [update_job](#update_job)
+ [abort_job](#abort_job)
* [Event Data Format](#event-data-format)
+ [Event Timing Object](#event-timing-object)
- [Development](#development)
* [Installing Dev Tools](#installing-dev-tools)
* [Manual Installation](#manual-installation)
* [Starting in Debug Mode](#starting-in-debug-mode)
* [Running Unit Tests](#running-unit-tests)
- [Colophon](#colophon)
- [License](#license)

## Glossary

Expand Down

0 comments on commit 16a61ef

Please sign in to comment.