Skip to content

Commit 81f2ea8

Browse files
committed
0.5.0 release
1 parent 4bd18a8 commit 81f2ea8

5 files changed

Lines changed: 53 additions & 3 deletions

File tree

docs/.vitepress/config.mts

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -73,6 +73,7 @@ export default defineConfig({
7373
},
7474
{text: 'Start Tweaking', link: '/start'},
7575
{text: 'Docker', link: '/docker'},
76+
{text: 'Kubernetes', link: '/kubernetes'},
7677
{text: 'SSH', link: '/ssh'},
7778
{text: 'Client Library', link: '/client'},
7879
],

docs/docker.md

Lines changed: 15 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,6 +2,8 @@
22

33
- [Introduction](#introduction)
44
- [Connect to Docker](#connect-to-docker)
5+
- [Local Docker](#local-docker)
6+
- [Docker over SSH](#docker-over-ssh)
57
- [Run Code](#run-code)
68
- [How it works?](#how-it-works)
79

@@ -13,12 +15,24 @@ TweakPHP enables you to run code inside docker containers.
1315

1416
After you opened a project, You can click on the docker icon at top toolbar and hit the connect item. Then a modal will apear to connect to any container you want.
1517

16-
Select the container and specify the working directory and hit the `connect` button.
18+
### Local Docker
19+
20+
Select the `local` host and then it will load the containers running on your machine. Select a container and specify the working directory and hit the `connect` button.
1721

1822
::: warning
1923
Make sure the docker service is running on your machine first
2024
:::
2125

26+
### Docker over SSH
27+
28+
Select any other SSH connections that you already have and then it will load the containers running on that machine. Select a container and specify the working directory and hit the `connect` button.
29+
30+
If you don't have any SSH connectinos, click on the plus icon to add one.
31+
32+
::: warning
33+
Make sure the docker service is running on your host first
34+
:::
35+
2236
## Run Code
2337

2438
Just like running code on the [Local](./start.md#run-code) mode, You can run the code on docker as well.

docs/getting-started/installation.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -48,4 +48,6 @@ TweakPHP is also available as `.deb` package for `x64` only and you can download
4848

4949
## Windows
5050

51-
We're working on the Windows build and we already have a [PR](https://github.com/tweakphp/tweakphp/pull/64) open 🤞
51+
Windows build is in `alpha` and available as `exe` file to download and install.
52+
53+
To install TweakPHP on Windows, Simply download the app from the [Github Releases](https://github.com/tweakphp/tweakphp/releases)

docs/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -56,5 +56,5 @@ features:
5656
- title: Windows
5757
icon:
5858
src: /windows.svg
59-
details: Soon!
59+
details: Available (Alpha)
6060
---

docs/kubernetes.md

Lines changed: 33 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,33 @@
1+
# Kubernetes
2+
3+
- [Introduction](#introduction)
4+
- [Requirements](#requirements)
5+
- [Connect to Pod](#connect-to-pod)
6+
- [Run Code](#run-code)
7+
- [How it works?](#how-it-works)
8+
9+
## Introduction
10+
11+
TweakPHP enables you to run code inside Kubernetes pods.
12+
13+
## Requirements
14+
15+
`kubectl` must be installed on your system and executable using `kubectl` command.
16+
17+
Also you need to have kubernetes context already set up.
18+
19+
## Connect to Pod
20+
21+
After you opened a project, You can click on the kubernetes icon at top toolbar and hit the connect item. Then a modal will apear to connect to pods.
22+
23+
Fill the form by selecting the context and then a namespace and the working directory on the pod.
24+
25+
After creating the connection, you can click on the Connect icon (WiFi) and it will load the existing pods. Select a pod and then it will connect.
26+
27+
## Run Code
28+
29+
Just like running code on the [Local](./start.md#run-code) mode, You can run the code on kubernetes as well.
30+
31+
## How it works?
32+
33+
Everytime you connect to a kubernetes pod, TweakPHP detects the PHP version installed and then copies the bundled client file (`.phar`) into the pod and then runs the code.

0 commit comments

Comments
 (0)