Skip to content

Latest commit

 

History

History
115 lines (76 loc) · 5.11 KB

installation.md

File metadata and controls

115 lines (76 loc) · 5.11 KB
Raw

ℹ️ Attractify Documentation

The following docs will help you to better understand, testdrive and later set up Attractify in production.

Contents

  • Getting started with the demo
  • Setup Attractify in production
  • Extend or modify Attractify

👍 Getting started with the demo

In order to try Attractify, we have prepared a demo that includes not only the Attractify platform, but also an example web shop. We named it Sportify and it should help you better understand the idea behind Attractify.

To try the demo you need a local Docker host with Docker Compose installed. We provide a docker-compose file that contains all the required services and also provides the sample store.

You just have to type the following command into your terminal. After a short wait, the individual services will start and you can play around with the demo.

curl -o compose.yaml "https://raw.githubusercontent.com/inovex/attractify/master/docker-compose.demo.yml" ; mkdir -p server/testdata/fixtures ; curl -o server/testdata/fixtures/postgres.sql "https://raw.githubusercontent.com/inovex/attractify/master/server/testdata/fixtures/postgres.sql"  ; docker-compose up

Once Attractify is started, you can visit the example shop under http://localhost:8000

The Attractify platform is available under http://localhost:8080. You can use the following credentials to login:

User: demo@example.com
Password: demo4321

To give you a small overview of the features and also see what Attractify can do, we have prepared a video.

🖥 Setup Attractify in production

Preparation

  1. Install Docker engine on all machines that should run parts of Attractify
  2. Make sure they are in the same subnet with ports 2377, 4789 and 7946 open
  3. You need to provide a json config file which format can be copied form config.sample.json
  4. Build the backend docker build -t production -f server/Dockerfile .
  5. Change the docker-compose.demo.yml as needed

Docker Swarm setup

  1. Choose one of your machines to be the manager docker swarm init --listen-addr <managers-ip-adress>:2377
  2. Join the manager with as many nodes as you want docker swarm join <managers-ip-adress>:2377
  3. Start the Attractify service sudo docker stack deploy --compose-file=<docker-compose-file> attractify
  4. List the running services docker service ls
  5. Scale some services for load-balancing and redundancy docker service scale <service>=<amount>

Create an initial user

Attractify uses a simple CLI-Tool for the initial user creation. You can reach the command through the docker service attractify-server.

  1. Get the container id docker ps -f name=attractify_server --quiet
  2. Connect to your Docker container docker exec -it CONTAINERID /bin/sh
  3. Create the user attractify create-user --config CONFIG -u USERNAME -e EMAIL -o ORGANIZATIONNAME [-t TIMEZONE]

Example: attractify create-user --config config.yml -u myuser -e myuser@myorganization.com -o "My Organization" -t Europe/Berlin

🛠 Extend or modify Attractify

Because Attractify is open source, you can customize and extend it to suit your needs. We use the following technologies.

Backend:

  • Go
  • PostgreSQL/CockroachDB
  • ClickhouseDB

Frontend:

  • Vue.js
  • Vuex

To make changes to the front- or backend, you should start the databases via Docker Compose file docker-compose.dev.yml in the repository root. Then you can start the frontend and backend separately.

Frontend

The frontend can either be launched in a Docker container if you don't have Node.js installed, or you can launch it locally with your existing Node.js installation.

In a Docker container...

cd frontend
./dev.sh

...or locally

cd frontend
yarn serve

Backend

The backend can be started with a local Go installation. In the backend there are different services that perform different tasks:

  • server - This provides the API and delivers the frontend.
  • cron - Takes care of the regular execution of routine jobs.
  • attractify - Is a CLI tool to perform certain admin tasks.

The individual commands are stored in the server/cmd directory.

To start the server, the dependencies in the form of the databases must be started first. then the server can be started with the following command.

go run cmd/server/main.go config.dev.json

Each of the individual commands requires a config file containing the connection details for the databases.

For the commands server and cron the config file is simply written directly after the command name as described above. For the Attractify command the config file is specified via a commandline argument --config config.json.

There are two config files in the repo:

  • config.dev.json contains all the settings to connect to the services in the docker compose environment.
  • config.sample.json is used by the demo application.

config.sample.json can also be used later as a basis for a production environment setup.