Document install.ohmyz.sh in wiki

Marc Cornellà 2023-12-01 16:25:32 +01:00
parent 7379c583ab
commit 6a847bbdbb
No known key found for this signature in database
GPG Key ID: 0314585E776A9C1B
2 changed files with 40 additions and 1 deletions

33
FAQ.md

@ -23,6 +23,7 @@ _If you don't find what you're looking for, and you think it should be covered b
- [How do I manually update Oh My Zsh from a script?](#how-do-i-manually-update-oh-my-zsh-from-a-script)
- [Common problems](#common-problems)
- [Installation](#installation)
- [I can't access the installer / connection timed out](#i-cant-access-the-installer--connection-timed-out)
- [My .zshrc file was deleted on install](#my-zshrc-file-was-deleted-on-install)
- [Font issues](#font-issues)
- [I have a weird character in my prompt](#i-have-a-weird-character-in-my-prompt)
@ -32,7 +33,7 @@ _If you don't find what you're looking for, and you think it should be covered b
- [Zsh errors](#zsh-errors)
- [zsh: no matches found](#zsh-no-matches-found)
- [Other problems](#other-problems)
- [kill-word or backward-kill-word do / don't delete a symbol WORDCHARS](#kill-word-or-backward-kill-word-do--dont-delete-a-symbol-wordchars)
- [`kill-word` or `backward-kill-word` do / don't delete a symbol (`WORDCHARS`)](#kill-word-or-backward-kill-word-do--dont-delete-a-symbol-wordchars)
- [Why shouldn't I install Oh My Zsh as root?](#why-shouldnt-i-install-oh-my-zsh-as-root)
<!-- /TOC -->
@ -197,6 +198,36 @@ Another option is to use the `omz` CLI. The `omz update` command triggers an upd
### Installation
#### I can't access the installer / connection timed out
Some countries such as India and China block access to `raw.githubusercontent.com`, which is where the installer is hosted.
If you can't access it, you can use our mirror at `install.ohmyz.sh` instead. Using it is as simple as replacing the URL:
```sh
# instead of this URL
sh -c "$(curl -fsSL https://raw.githubusercontent.com/ohmyzsh/ohmyzsh/master/tools/install.sh)"
# use this URL
sh -c "$(curl -fsSL https://install.ohmyz.sh)"
```
The same applies for the other installation methods, which are documented in [the README](https://github.com/ohmyzsh/ohmyzsh#basic-installation)
or in the [[Home]] page.
You might need this if you see any of these errors when running the install command:
```console
failed: Connection timed out.
curl(7): Failed to connect to raw.githubusercontent.com port 443: Connection timed out
curl(28): Failed to connect to raw.githubusercontent.com port 443 after <time> ms: Connection timed out
```
Similar issues:
[#11720](https://github.com/ohmyzsh/ohmyzsh/issues/11720)
[#11818](https://github.com/ohmyzsh/ohmyzsh/issues/11818)
[#11908](https://github.com/ohmyzsh/ohmyzsh/discussions/11908)
#### My .zshrc file was deleted on install
The installer script is designed to back up your existing `.zshrc` file, and any previous backups are also preserved.

@ -25,6 +25,14 @@ Oh My Zsh is an open source, community-driven framework for managing your [zsh](
**NOTE: the installer will rename an existing `.zshrc` file to `.zshrc.pre-oh-my-zsh`.**
- Alternatively, the installer is also mirrored outside GitHub. **Using this URL may be required if you're in a country like India or China, that blocks `raw.githubusercontent.com`**:
| Method | Command |
| :-------- | :----------------------------------------------- |
| **curl** | `sh -c "$(curl -fsSL https://install.ohmyz.sh)"` |
| **wget** | `sh -c "$(wget -O- https://install.ohmyz.sh)"` |
| **fetch** | `sh -c "$(fetch -o - https://install.ohmyz.sh)"` |
## Getting started
Once Oh My Zsh is installed: