Skip to content

Commit

Permalink
chore: install text
Browse files Browse the repository at this point in the history
  • Loading branch information
bumi committed Sep 6, 2024
1 parent 0cc152d commit f0c87f5
Show file tree
Hide file tree
Showing 2 changed files with 17 additions and 2 deletions.
17 changes: 16 additions & 1 deletion scripts/linux-x86_64/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,8 @@
## Requirements

- Linux distribution
- Runs pretty much on any VPS/server with 512MB RAM or more (+some swap space ideally)
- Runs pretty much on any VPS/server with 512MB RAM or more (1GB recommended / plus some swap space ideally)
- lightning port 9735 must be available

### Installation (non-Docker)

Expand Down Expand Up @@ -46,3 +47,17 @@ Make sure to backup your data directories:
The install script will add an update.sh script to update Alby Hub. It will download the latest version for you.

After the update you will have to unlock Alby Hub again.

### Using Docker

Alby Hub comes as docker image: [ghcr.io/getalby/hub:latest](https://github.com/getAlby/hub/pkgs/container/hub)

$ docker run -v .albyhub-data:/data -e WORK_DIR='/data' -p 8080:8080 ghcr.io/getalby/hub:latest`

We also provide a simple docker-compose file:

$ wget https://raw.githubusercontent.com/getAlby/hub/master/docker-compose.yml # <- edit for your needs, but defaults should work well
$ mkdir ./albyhub-data
$ docker-compose up # or docker-compose up --pull=always <- to make sure you get the latest images

Make sure to mount and backup the data working directory.
2 changes: 1 addition & 1 deletion scripts/linux-x86_64/phoenixd/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ Run your Alby Hub with phoenixd as a backend.
## Requirements

- Linux distribution
- Runs pretty much on any VPS or server
- Runs pretty much on any VPS or server (512MB+ memory recommended)

## Docker

Expand Down

0 comments on commit f0c87f5

Please sign in to comment.