public/immich
1
0
Fork 0
mirror of https://github.com/immich-app/immich.git synced 2025-12-10 21:53:45 +09:00
Code Issues Actions 7 Packages Projects Releases Wiki Activity

chore(docs): refactor pages (#1144)

Browse Source 
* chore(docs): refactor pages

* fix: links

* fix: broken link

* refactor: post install steps using partials
This commit is contained in:
Jason Rasmussen
2022-12-21 16:01:50 -05:00
committed by GitHub
parent 7966c925ea
commit 752b267399
67 changed files with 380 additions and 258 deletions
Download Patch File Download Diff File Expand all files Collapse all files

29
docs/docs/install/script.md Normal file
View File

@@ -0,0 +1,29 @@
---
sidebar_position: 2
---
# Install Script [Experimental]
:::caution
This method is experimental and not currently recommended for production use. For production, please refer to installing with [Docker Compose](/docs/install/docker-compose.md).
:::
In the shell, from a directory of your choice, run the following command:
```bash
curl -o- https://raw.githubusercontent.com/immich-app/immich/main/install.sh | bash
```
The script will perform the following actions:
1. Download [docker-compose.yml](https://github.com/immich-app/immich/blob/main/docker/docker-compose.yml), and the [.env](https://github.com/immich-app/immich/blob/main/docker/.env.example) file from the main branch of the [repository](https://github.com/immich-app/immich).
2. Populate the `.env` file with necessary information based on the current directory path.
3. Start the containers.
The web application will be available at `http://<machine-ip-address>:2283`, and the server URL for the mobile app will be `http://<machine-ip-address>:2283/api`
The directory which is used to store the library files is `./immich-data` relative to the current directory.
:::tip
For common next steps, see [Post Install Steps](/docs/install/post-install.md).
:::