diff --git a/README.md b/README.md index 13c01ed..4b62596 100644 --- a/README.md +++ b/README.md @@ -14,44 +14,60 @@ There are 2 methods to run Fediplan #### Steps -1. Clone this repo
+1. Install required programs + +2. Clone this repo
`git clone https://framagit.org/tom79/fediplan.git fediplan` -2. Build the Docker image
-`docker build -t fediplan fediplan` +3. Build the Docker image
+`docker build --tag fediplan fediplan` -3. Run the docker image
-`docker run fediplan` +4. Run the docker image
+`docker run --detach --restart unless-stopped --name fediplan fediplan:latest` -4. Find the IP
+5. Find the IP
+`docker inspect fediplan | grep IPAddress` - - Find 'CONTAINER ID' of fediplan's container
- `docker ps | grep fediplan` - - - Find IP address of the container
- `docker inspect | grep IPAddress` - -5. Open _:8080_ in your web browser +6. Fediplan should be available at _:8080_ ### 2. Manual install #### Required programs - `git` -- `php 8.3` and some extensions +- `php 8.3` with these extensions: + + For Composer + - `openssl` + - `phar` + - `iconv` + - `xml` + - `simplexml` + - `xmlwriter` + + For running + - `ctype` + - `curl` + - `dom` + - `fpm` + - `intl` + - `mbstring` + - `simplexml` + - `session` + - `tokenizer` + - `composer` ([getcomposer.org/download](https://getcomposer.org/download/)) #### Steps -1. Clone this repo
+1. Install required programs + +2. Clone this repo
`git clone https://framagit.org/tom79/fediplan.git fediplan` -2. Change directory to the cloned repo
-`cd fediplan` - 3. Install vendors
-`composer install -o` +`php composer.phar install --optimize-autoloader --working-dir=fediplan` -4. Point your server software to '_public_' folder +4. Point your server software to `fediplan/public` folder ### Support My work [fedilab.app/page/donations](https://fedilab.app/page/donations/)