2019-09-24 07:40:59 +01:00
|
|
|
# CORE
|
2013-08-29 15:21:13 +01:00
|
|
|
CORE: Common Open Research Emulator
|
2016-10-23 02:14:16 +01:00
|
|
|
|
2022-01-11 19:06:06 +00:00
|
|
|
Copyright (c)2005-2022 the Boeing Company.
|
2016-10-23 02:14:16 +01:00
|
|
|
|
2013-08-29 15:21:13 +01:00
|
|
|
See the LICENSE file included in this distribution.
|
|
|
|
|
|
2018-05-02 16:50:38 +01:00
|
|
|
## About
|
|
|
|
|
The Common Open Research Emulator (CORE) is a tool for emulating
|
|
|
|
|
networks on one or more machines. You can connect these emulated
|
|
|
|
|
networks to live networks. CORE consists of a GUI for drawing
|
|
|
|
|
topologies of lightweight virtual machines, and Python modules for
|
|
|
|
|
scripting network emulation.
|
2013-08-29 15:21:13 +01:00
|
|
|
|
2021-11-16 20:52:31 +00:00
|
|
|
## Quick Start
|
2022-10-13 18:15:38 +01:00
|
|
|
Requires Python 3.9+. More detailed instructions and install options can be found
|
2022-10-07 21:05:16 +01:00
|
|
|
[here](https://coreemu.github.io/core/install.html).
|
|
|
|
|
|
|
|
|
|
### Package Install
|
|
|
|
|
Grab the latest deb/rpm from [releases](https://github.com/coreemu/core/releases).
|
|
|
|
|
|
|
|
|
|
This will install vnoded/vcmd, system dependencies, and CORE within a python
|
|
|
|
|
virtual environment at `/opt/core/venv`.
|
|
|
|
|
```shell
|
|
|
|
|
sudo <yum/apt> install -y ./<package>
|
|
|
|
|
```
|
2021-11-16 20:52:31 +00:00
|
|
|
|
2022-10-07 21:05:16 +01:00
|
|
|
Then install OSPF MDR from source:
|
|
|
|
|
```shell
|
|
|
|
|
git clone https://github.com/USNavalResearchLaboratory/ospf-mdr.git
|
|
|
|
|
cd ospf-mdr
|
|
|
|
|
./bootstrap.sh
|
|
|
|
|
./configure --disable-doc --enable-user=root --enable-group=root \
|
|
|
|
|
--with-cflags=-ggdb --sysconfdir=/usr/local/etc/quagga --enable-vtysh \
|
|
|
|
|
--localstatedir=/var/run/quagga
|
|
|
|
|
make -j$(nproc)
|
|
|
|
|
sudo make install
|
|
|
|
|
```
|
|
|
|
|
|
|
|
|
|
### Script Install
|
|
|
|
|
The following should get you up and running on Ubuntu 22.04. This would
|
2021-11-16 20:52:31 +00:00
|
|
|
install CORE into a python3 virtual environment and install
|
|
|
|
|
[OSPF MDR](https://github.com/USNavalResearchLaboratory/ospf-mdr) from source.
|
|
|
|
|
|
|
|
|
|
```shell
|
|
|
|
|
git clone https://github.com/coreemu/core.git
|
|
|
|
|
cd core
|
2022-02-17 23:03:09 +00:00
|
|
|
# install dependencies to run installation task
|
2022-01-11 19:06:06 +00:00
|
|
|
./setup.sh
|
2022-02-17 23:17:07 +00:00
|
|
|
# run the following or open a new terminal
|
|
|
|
|
source ~/.bashrc
|
2022-01-11 19:06:06 +00:00
|
|
|
# Ubuntu
|
|
|
|
|
inv install
|
|
|
|
|
# CentOS
|
2022-02-28 18:03:34 +00:00
|
|
|
inv install -p /usr
|
2021-11-16 20:52:31 +00:00
|
|
|
```
|
|
|
|
|
|
2020-04-09 22:34:52 +01:00
|
|
|
## Documentation & Support
|
|
|
|
|
We are leveraging GitHub hosted documentation and Discord for persistent
|
|
|
|
|
chat rooms. This allows for more dynamic conversations and the
|
2018-05-02 16:50:38 +01:00
|
|
|
capability to respond faster. Feel free to join us at the link below.
|
2013-08-29 15:21:13 +01:00
|
|
|
|
2020-04-09 22:34:52 +01:00
|
|
|
* [Documentation](https://coreemu.github.io/core/)
|
|
|
|
|
* [Discord Channel](https://discord.gg/AKd7kmP)
|
