Skip to content
Open
Show file tree
Hide file tree
Changes from 4 commits
Commits
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
52 changes: 52 additions & 0 deletions explorer/Makefile
Original file line number Diff line number Diff line change
@@ -0,0 +1,52 @@
.PHONY: build_explorer install_explorer set_cap create_env

ifneq (,$(wildcard ./.env))
include .env
export
endif

create_env:
truncate -s0 /tmp/aligned_layer/explorer/.env
echo "RPC_URL=${RPC_URL}" >> /tmp/aligned_layer/explorer/.env
echo "ENVIRONMENT=${ENVIRONMENT}" >> /tmp/aligned_layer/explorer/.env
echo "ALIGNED_CONFIG_FILE=${ALIGNED_CONFIG_FILE}" >> /tmp/aligned_layer/explorer/.env
echo "PHX_HOST=${PHX_HOST}" >> /tmp/aligned_layer/explorer/.env
echo "ELIXIR_HOSTNAME=${ELIXIR_HOSTNAME}" >> /tmp/aligned_layer/explorer/.env
echo "PHX_SERVER=true" >> /tmp/aligned_layer/explorer/.env
echo "DB_NAME=${DB_NAME}" >> /tmp/aligned_layer/explorer/.env
echo "DB_USER=${DB_USER}" >> /tmp/aligned_layer/explorer/.env
echo "DB_PASS=${DB_PASS}" >> /tmp/aligned_layer/explorer/.env
echo "DB_HOST=${DB_HOST}" >> /tmp/aligned_layer/explorer/.env
echo "TRACKER_API_URL=${TRACKER_API_URL}" >> /tmp/aligned_layer/explorer/.env
echo "SECRET_KEY_BASE=${SECRET_KEY_BASE}" >> /tmp/aligned_layer/explorer/.env
echo "KEYFILE_PATH=/home/app/.ssl/key.pem" >> /tmp/aligned_layer/explorer/.env
echo "CERTFILE_PATH=/home/app/.ssl/cert.pem" >> /tmp/aligned_layer/explorer/.env

# on /tmp/aligned_layer/explorer/ as app
build_explorer: export MIX_ENV=prod
build_explorer:
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Isn't this missing: explorer_ecto_setup_db to do the migrations if needed?

mix local.hex --force
mix local.rebar --force
mix deps.get --only $(MIX_ENV)
echo $(ENVIRONMENT)
mix compile
pnpm --prefix=assets/ install
mix phx.digest
mix assets.deploy
mix release --overwrite

# on /tmp/aligned_layer/explorer/ as app
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Personally, I would remove these comments or make them a little more specific.

install_explorer:
mkdir -p /home/app/repos/explorer/
mv /tmp/aligned_layer/ /home/app/repos/explorer/

# on /home/app/repos/explorer/aligned_layer/explorer/ as admin
set_cap:
sudo setcap CAP_NET_BIND_SERVICE=+eip /home/app/repos/explorer/aligned_layer/explorer/_build/prod/rel/explorer/erts-14.2.1/bin/beam.smp

# on /home/app/repos/explorer/aligned_layer/explorer/ as app
run_service:
mkdir -p /home/app/config/
cp /home/app/repos/explorer/aligned_layer/explorer/.env /home/app/config/.env.explorer
systemctl --user daemon-reload
systemctl --user enable --now explorer
50 changes: 50 additions & 0 deletions explorer/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,50 @@
# Explorer

## Steps to build

1. Clone [Aligned Layer](https://github.com/yetanotherco/aligned_layer/) inside the `/tmp` directory.
```
cd /tmp/
git clone https://github.com/yetanotherco/aligned_layer
```

3. Head to the `explorer/` folder and run the following command:
```
RPC_URL=
ENVIRONMENT=
ALIGNED_CONFIG_FILE=
PHX_HOST=
ELIXIR_HOSTNAME=
PHX_SERVER=true
DB_NAME=
DB_USER=
DB_PASS=
DB_HOST=
TRACKER_API_URL=
SECRET_KEY_BASE=
KEYFILE_PATH=/home/app/.ssl/key.pem
CERTFILE_PATH=/home/app/.ssl/cert.pem
make create_env
Comment on lines +11 to +27
Copy link
Member

@MarcosNicolau MarcosNicolau Jan 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Why don't we instead pass a .env file path instead of providing all the vars in the console? I find it a little uncomfortable. Or instead, the create_env just creates the template, and then you go to the created file and fill in the variables.

```
> The values to be filled can be found inside the documentation.

3. Build the elixir application.
```
make build_explorer
```

4. Move the built binary outside `/tmp/` and move it to the actual location.
```
make install_explorer
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had to run this with sudo (I was logged as admin).

```

5. Set the `CAP_NET_BIND_SERVICE=+eip` to the elixir application to allow elixir to bind port `443`
```
make set_cap
```
> This step must be ran as user `admin`.

7. Enable the systemd service.
```
make run_service
```
Comment on lines +47 to +50
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a comment saying this should be run as app user.