Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

update some documentation #1262

Merged
merged 2 commits into from
Oct 19, 2024
Merged

update some documentation #1262

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8589317
Basic procedure for initializing new event
proditis Oct 18, 2024
6924d32
add initial FAQ for project
proditis Oct 18, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions FAQ.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
# Frequently Asked Questions
FAQ and common problems

## Ansible playbooks error `couldn't resolve module/action 'xyz'`
Make sure your ansible is up to date. Visit the official [ansible instructions](https://docs.ansible.com/ansible/latest/installation_guide/installation_distros.html) to install an updated version.
20 changes: 20 additions & 0 deletions docs/Initializing a new event.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
# Instructions for events
1. Create an empty github repo
2. Clone the repo locally
3. Clone echoctf.red repo into a temporary location
4. move all files from echoctf.red to the empty repo except `.git/`, `.github/`,
`.mkdocs.yml`, `.readthedocs.yml`, `README.md`, `FAQ.md`,
`docker-compose.yml`, `docker-compose-novpn.yml`, `docker-compose-novpn-macvlan.yml`,
`CREDITS.md`, `CONTRIBUTING.md`
5. `mkdir migrations`
6. edit `contrib/init.sh` and modify the database name on top of the file as well as and the **`sysconfig`** values
7. run `./init.sh settings services sql sysconfig init services tmuxs` (notice that `services` need to given twice)

In order to:
* attach to the existing development server run `tmux -L DATABASENAME attach`
* stop the development server run `tmux -L DATABASENAME kill-server`

## Modifying the participant interfaces
1. replace the following frontend images with ones of your liking
* `frontend/images/logo-small.png` small logo used on top of the right menu pane (200x40)
* `frontend/images/logo.png` same logo but larger (919x184)