changed readme
This commit is contained in:
parent
a2b03ad517
commit
63a0a383c3
1 changed files with 8 additions and 8 deletions
16
README.md
16
README.md
|
@ -22,14 +22,14 @@ the key variables being `PG_USER`, `PG_PASS`, `PG_HOST`, `PG_NAME` if you have a
|
||||||
### Installation
|
### Installation
|
||||||
|
|
||||||
Each script is numbered which give the order in which they need to be run - scripts with `5` in the name should only need to be run once.
|
Each script is numbered which give the order in which they need to be run - scripts with `5` in the name should only need to be run once.
|
||||||
- `00-create-pod.sh` - this creates a simple pod, in which the other containers will exist. It will also open port 5000 for incoming web access and map the folders in which persistent data will reside.
|
1. `00-create-pod.sh` - this creates a simple pod, in which the other containers will exist. It will also open port 5000 for incoming web access and map the folders in which persistent data will reside.
|
||||||
- `10-build-rebased.sh` - this will clone the current develop git repo and build an image from it. Re-running this script will effectively update the version of Rebased. This may take 10 minutes or so to run as it compiles the software.
|
2. `10-build-rebased.sh` - this will clone the current develop git repo and build an image from it. Re-running this script will effectively update the version of Rebased. This may take 10 minutes or so to run as it compiles the software.
|
||||||
- `20-create-db.sh` - this will create a postgres container in which the database will exist
|
3. `20-create-db.sh` - this will create a postgres container in which the database will exist
|
||||||
- `30-run-rebased.sh` - this creates the main Rebased container and starts the web server on port 5000 (you'll need a reverse proxy (HAProxy, httpd, nginx, etc.) to publish it). At start up, this will check the database and create the appropriate tables and extensions so things will work.
|
4. `30-run-rebased.sh` - this creates the main Rebased container and starts the web server on port 5000 (you'll need a reverse proxy (HAProxy, httpd, nginx, etc.) to publish it). At start up, this will check the database and create the appropriate tables and extensions so things will work.
|
||||||
- `35-gen-config.sh` - YOU SHOULD ONLY NEED TO RUN THIS ONCE. Will generate a `generated_config.exs` file. Make sure you set the port number correctly (5000, not 4000). Once generated, it should be renamed to `prod.secret.exs` to make it available at run-time
|
5. `35-gen-config.sh` - YOU SHOULD ONLY NEED TO RUN THIS ONCE. Will generate a `generated_config.exs` file. Make sure you set the port number correctly (5000, not 4000). Once generated, it should be renamed to `prod.secret.exs` to make it available at run-time
|
||||||
- at this point you should re-run `30-run-rebased.sh`
|
6. at this point you should re-run `30-run-rebased.sh`
|
||||||
- Now, you're instance should be running on your device at port 5000 - test it and find out.
|
7. Now, you're instance should be running on your device at port 5000 - test it and find out.
|
||||||
- `40-install-soapbox.sh` - this installs the [Soapbox](https://soapbox.pub/) front end - which is where you will log in and ultimately use the system.
|
8. `40-install-soapbox.sh` - this installs the [Soapbox](https://soapbox.pub/) front end - which is where you will log in and ultimately use the system.
|
||||||
|
|
||||||
Once the above steps are complete, you're nearly ready to go! The final steps are to
|
Once the above steps are complete, you're nearly ready to go! The final steps are to
|
||||||
1. Create your admin user
|
1. Create your admin user
|
||||||
|
|
Loading…
Reference in a new issue