Skip to content

Commit ea09082

Browse files
Update README.md
1 parent 27352e1 commit ea09082

1 file changed

Lines changed: 60 additions & 0 deletions

File tree

README.md

Lines changed: 60 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,62 @@
11
# CTX-Backup-Flows
22
The module allows users to configure Cortex to create automated backups of the system, a set of flows within a specific groups, or a set of specific flows.
3+
4+
## Table of Contents
5+
1) [Dependencies](#dependencies)
6+
* [Cortex Version](#cortex-version)
7+
* [OCIs](#ocis)
8+
* [Files](#files)
9+
* [Other](#other)
10+
2) [Installation](#installation)
11+
3) [How to use](#how-to-use)
12+
4) [How you can contribute](#how-you-can-contribute)
13+
5) [Versioning](#versioning)
14+
6) [Licensing](#licensing)
15+
16+
17+
## Dependencies
18+
### Cortex Version
19+
This version of the BackupFlows module was developed in Cortex version 6.4. Some functionality may not be available on different verions of Cortex.
20+
21+
### OCIs
22+
The module requires the following Cortex OCIs:
23+
* PowerShell
24+
25+
### Files
26+
The BackupFlows module requires the following files:
27+
* [BackupFlows.studiopkg](https://github.com/CortexIntelligentAutomation/CTX-Backup-Flows/releases/download/v1.0/CTX-Backup-Flows.studiopkg)
28+
29+
### Other
30+
The BackupFlows module has the following additional requirements which are explained in detail in the [Installation section](#Installation):<Other Requirements>
31+
* CTX-Email Module
32+
33+
## Installation
34+
Details of the installation can be found in the [BackupFlows Deployment Plan](https://github.com/CortexIntelligentAutomation/CTX-Backup-Flows/blob/master/CTX-Backup-Flows%20-%20Deployment%20Plan.pdf).
35+
36+
## How to use
37+
A detailed User Guide has been provided with instructions on how to use the flows/subtasks, available [here](https://github.com/CortexIntelligentAutomation/CTX-Backup-Flows/blob/master/CTX-Backup-Flows%20-%20User%20Guide.pdf). Configuration of Config Files are details in this document.
38+
39+
## How you can contribute
40+
Unfortunately, we cannot offer pull requests at this time or accept any improvements.
41+
42+
## Versioning
43+
BackupFlows has the following versions, starting with the most recent:<Module Version History>
44+
45+
## Licensing
46+
All functionality within this module is licensed under the [Apache 2.0 License](https://www.apache.org/licenses/LICENSE-2.0).
47+
48+
Copyright 2018 Cortex Limited
49+
50+
Licensed under the Apache License, Version 2.0 (the "License");
51+
you may not use this file except in compliance with the License.
52+
You may obtain a copy of the License at
53+
54+
http://www.apache.org/licenses/LICENSE-2.0
55+
56+
Unless required by applicable law or agreed to in writing, software
57+
distributed under the License is distributed on an "AS IS" BASIS,
58+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
59+
See the License for the specific language governing permissions and
60+
limitations under the License.
61+
62+

0 commit comments

Comments
 (0)