Grammar and syntax edits for the new docs (#936)

* Update introduction.mdx

* Update logo-mearning.md

* Update support-the-project.md

Fixing more grammar/syntax :)

* Update one-step-installation.md

* Update recommended-installation.md

* Update requirements.md

* Update automatic-backup.md

* Update bulk-upload.md

* Update post-installation.md

* Update update.md

* Update contribution-guidelines.md
This commit is contained in:
Coyote6705
2022-11-06 22:27:14 -05:00
committed by GitHub
parent 2ff1a81f19
commit 948ff5530c
11 changed files with 37 additions and 37 deletions

View File

@@ -5,10 +5,10 @@ sidebar_position: 2
# One-step installation
:::caution
This method is for evaluation purposes only. It is not recommended for production use. For production usage, please refer to the recommneded installation method [here](/docs/installation/recommended-installation).
This method is for evaluation purposes only. It is not recommended for production use. For production usage, please refer to the recommended installation method [here](/docs/installation/recommended-installation).
:::
In the shell, from the directory of your choice, run the following command:
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
@@ -26,4 +26,4 @@ The directory which is used to store the backup file is `./immich-app/immich-dat
:::tip
For more information on how to use the application, please refer to the [Post Installation](/docs/usage/post-installation) guide.
:::
:::

View File

@@ -103,7 +103,7 @@ PUBLIC_LOGIN_PAGE_MESSAGE="My Family Photos and Videos Backup Server"
* Populate custom database information if necessary.
* Populate `UPLOAD_LOCATION` as prefered location for storing backup assets.
* Populate a secret value for `JWT_SECRET`, you can use the command below to generate a secured key
* Populate a secret value for `JWT_SECRET`, you can use the command below to generate a secure key
```bash title="Command to generate secure JWT_SECRET key"
openssl rand -base64 128
@@ -117,4 +117,4 @@ docker-compose up -d # or `docker compose up -d` based on your docker-compose ve
:::tip
For more information on how to use the application, please refer to the [Post Installation](/docs/usage/post-installation) guide.
:::
:::

View File

@@ -4,7 +4,7 @@ sidebar_position: 1
# Requirements
Hardware and software requirement for Immich
Hardware and software requirements for Immich
## Software
@@ -12,18 +12,18 @@ Hardware and software requirement for Immich
- [Docker Compose](https://docs.docker.com/compose/install/)
:::info Podman
You can also use Podman to run the application, however, additional configurations might required on your end.
You can also use Podman to run the application. However, additional configurations might be required on your end.
:::
## Hardware
- **OS**: Preferred unix-based operating system (Ubuntu, Debian, MacOS...etc). Windows works too with [Docker Desktop on Windows](https://docs.docker.com/desktop/install/windows-install/)
- **OS**: Preferred unix-based operating system (Ubuntu, Debian, MacOS...etc). Windows works too, with [Docker Desktop on Windows](https://docs.docker.com/desktop/install/windows-install/)
- **Ram**: At least 2GB, preferred 4GB.
- **Core**: At least 2 cores, preferred 4 cores.
## Installation methods
There are a couple installation method that you can use to install the application. You can choose the one that suits you the best.
There are a couple installation methods that you can use to install the application. You can choose the one that suits you the best.
1. [One-step installation (Evaluation only)](/docs/installation/one-step-installation)
2. **[Docker Compose with manual configuration (Recommended)](/docs/installation/recommended-installation)**