Skip to content

Commit fe9fb68

Browse files
aboseabose
committed
update docs
1 parent ad41810 commit fe9fb68

2 files changed

Lines changed: 99 additions & 6 deletions

File tree

‎.phcode.json‎

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
{
2+
"livePreviewUseDevServer": true,
3+
"livePreviewServerURL": "http://localhost:3000/",
4+
"livePreviewServerProjectPath": "/",
5+
"livePreviewHotReloadSupported": true,
6+
"livePreviewFramework": "Docusaurus"
7+
}

‎docs/Install/Linux.md‎

Lines changed: 92 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,9 +1,14 @@
11
---
2-
title: Installing Phoenix Code on Linux
2+
title: Linux
33
---
44

5+
import Tabs from '@theme/Tabs';
6+
import TabItem from '@theme/TabItem';
7+
8+
59
## Overview
6-
This guide details how to install Phoenix Code on Linux systems. Our installer works with major Linux distributions(Ubuntu, Debian, Fedora, and Arch-based systems).
10+
This guide details how to install Phoenix Code on Linux systems. Our installer works with major
11+
Linux distributions(Ubuntu, Debian, Fedora, and Arch-based systems).
712

813
## Automatic Installation
914
To install Phoenix Code automatically, execute the following command in your terminal:
@@ -15,6 +20,13 @@ wget -qO- https://updates.phcode.io/linux/installer.sh | bash
1520
This script automatically installs Phoenix Code and all required dependencies.
1621
It will also setup app drawer shortcuts and file associations.
1722

23+
**Uninstall**
24+
25+
Execute the following command in your terminal.
26+
```bash
27+
wget -qO- https://updates.phcode.io/linux/installer.sh | bash -s -- --uninstall
28+
```
29+
1830
## Manual Installation
1931
If automatic installation fails or manual installation is preferred, follow these steps:
2032

@@ -48,15 +60,89 @@ Other desktop environments may be compatible with [Manual Installation](#manual-
4860

4961
## FAQ
5062
**Q: How can I verify if my distribution is supported?**
51-
A: Run the [Automatic Installation](#automatic-installation). If it completes successfully, your distribution is supported.
63+
64+
Run the [Automatic Installation](#automatic-installation). If it completes successfully,
65+
your distribution is supported.
5266

5367
**Q: How do I upgrade Phoenix Code?**
54-
A: For automatic installations, you will receive an update notification in the app itself.
68+
69+
For automatic installations, you will receive an update notification in the app itself.
5570
For [Manual Installations](#manual-installation), follow the section again.
5671

5772
**Q: How do I uninstall Phoenix Code?**
58-
A: For automatic installations, use the command:
73+
74+
For automatic installations, use the command:
5975
```bash
6076
wget -qO- https://updates.phcode.io/linux/installer.sh | bash -s -- --uninstall
6177
```
62-
For manual installations, delete the folder where you placed Phoenix Code App and remove any related files.
78+
For manual installations, delete the folder where you placed Phoenix Code App and remove any related files.
79+
80+
**Q: Phoenix is not starting up after install. What can I do?**
81+
82+
Restart your system. Confirm that the required dependencies listed below in your Linux distribution are installed.
83+
84+
85+
<Tabs
86+
defaultValue="ubuntu"
87+
values={[
88+
{ label: 'Ubuntu/Debian', value: 'ubuntu' },
89+
{ label: 'Fedora/Red Hat', value: 'fedora' },
90+
{ label: 'Arch Linux', value: 'arch' },
91+
]}>
92+
93+
<TabItem value="ubuntu">
94+
95+
Update your package list:
96+
```bash
97+
sudo apt update
98+
```
99+
100+
Install WebKitGTK and GTK:
101+
```bash
102+
sudo apt install libgtk-3-0 libwebkit2gtk-4.0-37
103+
```
104+
*Note: In Ubuntu 22+ versions, WebKitGTK may be pre-installed.*
105+
106+
Install optional GStreamer plugins for media playback:
107+
```bash
108+
sudo apt install gstreamer1.0-plugins-base gstreamer1.0-plugins-good gstreamer1.0-plugins-bad gstreamer1.0-plugins-ugly gstreamer1.0-tools gstreamer1.0-libav
109+
```
110+
111+
</TabItem>
112+
<TabItem value="fedora">
113+
114+
Update your package list:
115+
```bash
116+
sudo dnf update
117+
```
118+
119+
Install WebKitGTK and GTK:
120+
```bash
121+
sudo dnf install webkit2gtk3 gtk3
122+
```
123+
124+
Install optional GStreamer plugins for media playback:
125+
```bash
126+
sudo dnf install gstreamer1-plugins-base gstreamer1-plugins-good gstreamer1-plugins-bad-free gstreamer1-plugins-bad-freeworld gstreamer1-plugins-ugly gstreamer1-libav
127+
```
128+
129+
</TabItem>
130+
<TabItem value="arch">
131+
132+
Ensure your system is up to date:
133+
```bash
134+
sudo pacman -Syu
135+
```
136+
137+
Install WebKitGTK and GTK:
138+
```bash
139+
sudo pacman -S webkit2gtk gtk3
140+
```
141+
142+
Install optional GStreamer plugins for media playback:
143+
```bash
144+
sudo pacman -S gst-plugins-base gst-plugins-good gst-plugins-bad gst-plugins-ugly gst-libav
145+
```
146+
147+
</TabItem>
148+
</Tabs>

0 commit comments

Comments
 (0)