Update readme

This commit is contained in:
0xd9a 2024-05-18 18:03:39 +00:00 committed by Thomas
parent 2c773d7795
commit 6e6d2cb3a1

View file

@ -14,44 +14,60 @@ There are 2 methods to run Fediplan
#### Steps
1. Clone this repo<br>
1. Install required programs
2. Clone this repo<br>
`git clone https://framagit.org/tom79/fediplan.git fediplan`
2. Build the Docker image<br>
`docker build -t fediplan fediplan`
3. Build the Docker image<br>
`docker build --tag fediplan fediplan`
3. Run the docker image<br>
`docker run fediplan`
4. Run the docker image<br>
`docker run --detach --restart unless-stopped --name fediplan fediplan:latest`
4. Find the IP<br>
5. Find the IP<br>
`docker inspect fediplan | grep IPAddress`
- Find 'CONTAINER ID' of fediplan's container<br>
`docker ps | grep fediplan`
- Find IP address of the container<br>
`docker inspect <CONTAINER ID> | grep IPAddress`
5. Open _<ip_address>:8080_ in your web browser
6. Fediplan should be available at _<ip_address>: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<br>
1. Install required programs
2. Clone this repo<br>
`git clone https://framagit.org/tom79/fediplan.git fediplan`
2. Change directory to the cloned repo<br>
`cd fediplan`
3. Install vendors<br>
`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/)