Table of Contents

1. Introduction   1.1

2. Book Convention   1.2

3. Quick Start   1.3

4. Requirements   1.4

5. FAQ   1.5

6. Dev FAQ   1.6

7. Best Practices   1.7

8. Appendices   1.8

Last modified: Fri Jun 10 2022 13:11:53 GMT+0000 (Coordinated Universal Time)

Introduction

User guide for openXeco - Open Source Ecosystem Management Tool. This guide is intenden for users of the platform as well as administrators taking care of openXeco nodes. Day-to-day uses are highlighted and ecosystem member management is covered too. Automation is covered to via its automated interfaces (API), in order to integrate openXeco data into other processes and workflows.

Acknowledgment

The openXeco user guide is a collaborative effort between all the contributors to openXeco including:

- Security made in Lëtzebuerg

Contributing

We welcome contributions to the openXeco book. If you want to contribute, see our contributing guide

Format

OpenXeco book is available in HTML, PDF, ePub and Kindle mobi format.

License

The openXeco user guide is dual-licensed under BSD-2-Clause and CC-BY 4.0 international.

- Copyright (C) 2022 Steve Clement

- Copyright (C) 2022 Alexis Prunier

- Copyright (C) 2022 Rémi Laurent

Last modified: Fri Jun 10 2022 13:11:53 GMT+0000 (Coordinated Universal Time)

description: Convention Used in openXeco-book

Convention Used in This Book

code block or value

- Used for variable, function or menu names in openXeco.

Language

The language in this book is American English. All the screenshots and examples are in English.

CoC

The same code of conduct applies to this book as for the main openXeco project. As a book can some times be considered the inadvertent soul of a piece of software, please take good care and consideration of our  Code of Conduct . The CoC can be read here.

Example install

The examples and screenshots provided in this book have been created with the openXeco Autogenerated VM.

To get a copy of the latest VM click here

openXeco Instance

In general when talking about a network of inter-connected openXeco servers, each server is an openXeco node. Whilst we have no strong feelings towards anyones naming schemes, as a rule of thumb try to have a scheme that makes everyday use easy when users need to talk about remote openXeco nodes.

The hostname used for the instance in this book is  openxeco.local  and we will henceforth refer to it either by name or as  local openXeco instance .

Example organisations

As example organisations a fictional Cybersecurity Ecosystem is used as well as a fictional Helthtec Ecosystem.

Cyber ecosystem actors:

- Cyber ACME S.A

- Cyber Beagle s.à r.l

Healthtec ecosystem actors:

- MyHealth S.A

- Health Data Inc.

Example users

The users are purely fictional. Where it made sense, distribution lists were used as users. As a good practice, the organisations admin should be a nominative person and shall be changed if the person in charge will move on to other ventures.

Example taxonomies

For the Cybersecurity ecosystem the ECSO taxonmy shall be used.

As no knwown and widely deployed Healthtec taxonomy is in use, we will create a very basic Taxonmy from scratch and learn how to create custom taxonomies.

Articles

Under articles we understand: news, events, job offers, services, tools etc.

Example news

The news example are chosen randomly at the time of the documentations writing and are always related to the activities of the example organisations.

Example jobs

The jobs in the examples are purely fictional.

Example services

The services in the examples are purely fictional.

Example tools

The tools in the examples are purely fictional but can be real projects as well.

Real-life coincidences

Any of the above examples, in the rare occasions where they reflect any real-life facts, are purely coincidental.

Last modified: Fri Jun 10 2022 13:11:53 GMT+0000 (Coordinated Universal Time)

Quick Start

Intro

Installation

Development environment

To install a development instance please follow the openXeco-core README.

Production environment

Production environment installs are documented in the main openXeco-core repository.

Login into openXeco

openXeco default credentials:

Username:

admin@admin.test

Password:

admin

I forgot my admin password :(

TODO: How to reset on CLI

Tasks to do after first Start

1. Change password

2. Add users

3. etc

Password Policy

- [12]: Ensure that the password is at least 12 characters long

- [A-Z]: contains at least one upper-case

- [0-9| ]: includes a digit or a special character

- [a-z]: at least one lower-case character.

If you need a password generator use:

- Ubuntu / Debian: pwgen

- Website: LastPass PW Generator

- Built-in generator in Keepass* and other passwort manager

- Built-in generator in various web browsers

All Generator tools are only possibilities without any guarantee!

tl;dr

Create an organization

Add figure

Last modified: Fri Jun 10 2022 13:11:53 GMT+0000 (Coordinated Universal Time)

openXeco Instance requirements

- Intro

Intro

There are various ways you can run an openXeco instance.

- Virtualized with docker

- VMware/Virtualbox

- Dedicated hardware

Whilst there is never an ultimate answer to what specifications a system needs, we try to give an approximate answer depending on your use case.

Last modified: Fri Jun 10 2022 13:11:53 GMT+0000 (Coordinated Universal Time)

- Frequently Asked Questions

- General questions

- Where can I get support?

- What are the hardware requirements?

- How to monitor openXeco?

- Specific questions

- Can I configure openXeco to send encrypted notification mails

Frequently Asked Questions

The following page hosts some frequently asked questions as noticed in our issues.

General questions

Where can I get support?

If you have feature requests or you found a bug you can open a ticket on openXeco's GitHub repository issue tracker.

What are the hardware requirements?

From a hardware perspective, openXeco's requirements are in the mid-range, a web server with 4+ cores and 16-24 GB of memory should be plenty, though more is always better of course. A lot of it depends on the data set and the number of users you are dealing with.

We recommend a standard LAM stack on top of Ubuntu >20.04 LTS. For details on the exact dependencies please refer to the installation guide.

How to monitor openXeco?

Specific questions

Can I configure openXeco to send encrypted notification mails

Last modified: Fri Jun 10 2022 13:11:53 GMT+0000 (Coordinated Universal Time)

Developer FAQ

Main Developer Resources

"But I must explain to you how all this mistaken idea of denouncing pleasure and praising pain was born and I will give you a complete account of the system, and expound the actual teachings of the great explorer of the truth, the master-builder of human happiness. No one rejects, dislikes, or avoids pleasure itself, because it is pleasure, but because those who do not know how to pursue pleasure rationally encounter consequences that are extremely painful. Nor again is there anyone who loves or pursues or desires to obtain pain of itself, because it is pain, but because occasionally circumstances occur in which toil and pain can procure him some great pleasure. To take a trivial example, which of us ever undertakes laborious physical exercise, except to obtain some advantage from it? But who has any right to find fault with a man who chooses to enjoy a pleasure that has no annoying consequences, or one who avoids a pain that produces no resultant pleasure?"

Last modified: Fri Jun 10 2022 13:11:53 GMT+0000 (Coordinated Universal Time)

- Best Practices

Best Practices

The following page hosts some best practices for the usage of the openXeco platform.

Last modified: Fri Jun 10 2022 13:11:53 GMT+0000 (Coordinated Universal Time)

Summary

- Appendix A: Place Holder

* [Appendix A things](#appendix-a-things)

- Appendix B: Place Holder

* [Appendix B things](#appendix-b-things)

Appendix A: Place Holder

Appendix A things

"Neque porro quisquam est qui dolorem ipsum quia dolor sit amet, consectetur, adipisci velit..."

Appendix B: Place Holder

Appendix B things

"Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum."

Table of Contents

Introduction

Book Convention

Quick Start

Requirements

FAQ

Dev FAQ

Best Practices

Appendices