Skip to content

Commit 6fc704d

Browse files
muhsinkingjustinwlin
authored andcommitted
Copyedits for community solution section
1 parent 4e1a37f commit 6fc704d

File tree

5 files changed

+86
-127
lines changed

5 files changed

+86
-127
lines changed

community-solutions/copyparty-file-manager/overview.mdx

Lines changed: 26 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ icon: "party-horn"
66

77
# Setting up CopyParty on Runpod
88

9-
CopyParty provides a web-based GUI that makes file management simple on Runpod instances. With its intuitive interface, you can browse directories, upload/download files, preview images and videos, and manage your Pod's filesystem without complex command-line operations.
9+
CopyParty provides a webbased GUI that makes file management simple on Runpod instances. With its intuitive interface, you can browse directories, upload/download files, preview images and videos, and manage your Pod's filesystem without complex command-line operations.
1010

1111
## About CopyParty
1212

@@ -28,18 +28,18 @@ You can access the terminal in two ways:
2828
If you see this option when clicking "Connect" on your Pod page, you have web terminal access:
2929
![Web Terminal Access](webterminal.png)
3030

31-
#### Option 2: Jupyter Labs Terminal
32-
If you have Jupyter Labs installed, you can access the terminal there:
33-
![Jupyter Labs Terminal](labsterminal.png)
31+
#### Option 2: JupyterLab terminal
32+
If you have JupyterLab installed on your Pod, you can access the terminal there:
33+
![JupyterLab Terminal](labsterminal.png)
3434

35-
## Installation Steps
35+
## Installation steps
3636

37-
### Step 1: Access Your Pod Settings
37+
### Step 1: Access your pod settings
3838

3939
Navigate to your pod page and locate the settings:
4040
![Edit Pod Settings](edit.png)
4141

42-
### Step 2: Add an HTTP Port
42+
### Step 2: Add an HTTP port
4343

4444
<Warning>
4545
**Adding a new port will restart your pod and erase any data not stored in `/workspace`**
@@ -51,11 +51,11 @@ Add a dedicated HTTP port for the CopyParty interface. If port 8888 is already i
5151

5252
![Add HTTP Port](addhttp.png)
5353

54-
### Step 3: Install and Run CopyParty
54+
### Step 3: Install and run CopyParty
5555

5656
Open your terminal (web terminal or Jupyter terminal) and run one of the following commands:
5757

58-
#### Option 1: Standard Installation
58+
#### Option 1: Standard installation
5959
Run CopyParty directly (the session will end if you close the terminal):
6060

6161
```bash
@@ -64,8 +64,9 @@ curl -LsSf https://astral.sh/uv/install.sh | sh && source $HOME/.local/bin/env &
6464

6565
Replace `-p 8000` with your chosen port number if different.
6666

67-
#### Option 2: Background Installation with tmux
68-
To keep CopyParty running even after closing the terminal, use tmux:
67+
#### Option 2: Background installation with tmux
68+
69+
To keep CopyParty running even after closing the terminal, use `tmux`:
6970

7071
```bash
7172
apt-get update && apt-get install tmux -y && tmux new-session -d -s copyparty 'curl -LsSf https://astral.sh/uv/install.sh | sh && source $HOME/.local/bin/env && uv tool run copyparty -p 8000 --allow-csrf' && tmux attach -t copyparty
@@ -74,7 +75,7 @@ apt-get update && apt-get install tmux -y && tmux new-session -d -s copyparty 'c
7475
<Info>
7576
**What is tmux?**
7677

77-
tmux (terminal multiplexer) is a tool that lets you run terminal sessions in the background. Think of it as a way to keep programs running even after you close your terminal window - like minimizing an app instead of closing it. This is particularly useful on RunPod where you want CopyParty to keep running even if you disconnect.
78+
`tmux` (terminal multiplexer) is a tool that lets you run terminal sessions in the background. Think of it as a way to keep programs running even after you close your terminal window, like minimizing an app instead of closing it. This is particularly useful on Runpod where you want CopyParty to keep running even if you disconnect.
7879

7980
For a more in-depth tmux tutorial, check out this [comprehensive video guide](https://youtu.be/nTqu6w2wc68?si=OcI3qbh2kGH7_3fh).
8081
</Info>
@@ -92,24 +93,24 @@ This command:
9293
- To stop CopyParty: Reattach and press `Ctrl+C`
9394
</Tip>
9495

95-
### Step 4: Access the CopyParty Interface
96+
### Step 4: Access the CopyParty interface
9697

97-
Once CopyParty is running, click on the port number in your RunPod dashboard:
98+
Once CopyParty is running, click on the port number in your Runpod dashboard:
9899
![Access Port](port.png)
99100

100101
## Using CopyParty
101102

102-
### File Navigation
103+
### File navigation
103104

104105
The interface displays your file system on the left side:
105106
![Directory View](directory.png)
106107

107-
### Uploading Files
108+
### Uploading files
108109

109110
Simply drag and drop files into the interface to upload them:
110111
![Upload Files](upload.png)
111112

112-
### Downloading Files
113+
### Downloading files
113114

114115
To download files:
115116
1. Click on files to select them (they'll be highlighted in pink)
@@ -119,27 +120,23 @@ To download files:
119120

120121
![Download Files](download.png)
121122

122-
## Tips and Best Practices
123+
## Tips and best practices
123124

124125
1. **Data Persistence**: Always store important files in `/workspace` to survive pod restarts
125126
2. **Port Selection**: Choose a port that doesn't conflict with other services (avoid 8888 if using Jupyter)
126127
3. **Large Files**: CopyParty handles large file transfers well, making it ideal for model weights and datasets
127128

128129
## Troubleshooting
129130

130-
### Session Ends When Terminal Closes
131+
### Session ends when terminal closes
131132
Use the tmux option (Option 2) to keep CopyParty running in the background
132133

133-
## Alternative File Transfer Methods
134+
## Alternative file transfer methods
134135

135-
While CopyParty provides an excellent web-based solution, RunPod also supports:
136+
While CopyParty provides an excellent web-based solution, Runpod also supports:
136137
- Direct SSH/SCP transfers (if SSH is enabled)
137-
- Jupyter Labs file browser
138-
- RunPodctl CLI tool
139-
- Cloud storage integration (S3, Google Drive, etc.)
140-
141-
Choose the method that best fits your workflow and security requirements.
142-
143-
## Conclusion
138+
- JupyterLab file browser
139+
- [Runpod CLI](/runpodctl/overview) tool
140+
- [Cloud storage integration](/pods/storage/cloud-sync) (S3, Google Drive, etc.)
144141

145-
CopyParty provides a simple, effective solution for file management on RunPod instances. With its drag-and-drop interface and support for large files, it's an excellent tool for managing datasets, model weights, and project files on your cloud GPU instances.
142+
Choose the method that best fits your workflow and security requirements.

community-solutions/ohmyrunpod/overview.mdx

Lines changed: 24 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -6,15 +6,13 @@ icon: "rocket"
66

77
## What is OhMyRunPod?
88

9-
OhMyRunPod is a Python package that solves one of the most common Runpod user problems: **easily transferring files to and from your Pod**.
9+
OhMyRunPod is a Python package that solves one of the most common Runpod user challenges: **easily transferring files to and from your Pod**.
1010

11-
While OhMyRunPod includes various features, **the SFTP setup functionality** is the one we want to highlight to help easily get setup with file transfer software such as filezilla or similar tools.
11+
While OhMyRunPod includes various features, **the SFTP setup functionality** is the one we want to highlight to help get you started with file transfer software such as FileZilla or similar tools.
1212

13-
<Info>
14-
**GitHub Repository**: [github.com/kodxana/OhMyRunPod-python](https://github.com/kodxana/OhMyRunPod-python)
15-
16-
Check the repository for additional features, updates, and documentation.
17-
</Info>
13+
<Note>
14+
Check the repository for additional features, updates, and documentation: [github.com/kodxana/OhMyRunPod-python](https://github.com/kodxana/OhMyRunPod-python)
15+
</Note>
1816

1917
## Key features
2018

@@ -29,7 +27,7 @@ Check the repository for additional features, updates, and documentation.
2927

3028
## Requirements
3129

32-
Before getting started with OhMyRunPod, ensure you have:
30+
Before getting started with OhMyRunPod, make sure you have:
3331

3432
- An active Runpod account with a running Pod.
3533
- Python 3.6 or higher installed on your local machine.
@@ -52,24 +50,24 @@ The most common use case for OhMyRunPod is transferring files between your local
5250
Before starting, make sure port 22 is exposed in your Pod. This is required for SFTP transfers.
5351

5452
To expose port 22:
55-
1. Go to your Pod in the RunPod console
53+
1. Go to your Pod in the Runpod console
5654
2. Click **Edit Pod**
5755
3. Under the **TCP Ports** section, add port `22`
5856
4. Save the changes
5957

6058
<Warning>
61-
**Data Loss Warning**: Changing TCP ports will restart your pod and **erase all data outside of `/workspace`**. Ensure all important files are in `/workspace` (the default persistent directory) before making port changes.
59+
**Data loss warning**: Changing TCP ports will restart your pod and **erase all data outside of `/workspace`**. Ensure all important files are in `/workspace` (the default persistent directory) before making port changes.
6260
</Warning>
6361
</Step>
6462

65-
<Step title="Run File Transfer Command">
63+
<Step title="Run the file transfer command">
6664
Execute the file transfer command:
6765
```bash
68-
OhMyRunPod --file-transfer
66+
OhMyRunpod --file-transfer
6967
```
7068
</Step>
7169

72-
<Step title="Choose Transfer Method">
70+
<Step title="Choose a transfer method">
7371
You'll be presented with transfer options:
7472

7573
<Frame>
@@ -82,7 +80,7 @@ The most common use case for OhMyRunPod is transferring files between your local
8280
Use arrow keys to navigate and Enter to select.
8381
</Step>
8482

85-
<Step title="SFTP Setup Complete">
83+
<Step title="SFTP setup complete">
8684
If you choose SFTP, OhMyRunpod will automatically:
8785
- Install and configure SSH server
8886
- Set up SSH keys
@@ -100,7 +98,7 @@ The most common use case for OhMyRunPod is transferring files between your local
10098
</Step>
10199
</Steps>
102100

103-
## What Can You Do After Setup?
101+
## What can you do after setup?
104102

105103
Once SFTP is configured, you can:
106104

@@ -114,16 +112,16 @@ Once SFTP is configured, you can:
114112
## Troubleshooting
115113

116114
<AccordionGroup>
117-
<Accordion title="Connection Refused on Port 22">
115+
<Accordion title="Connection refused on port 22">
118116
**Problem:** Cannot connect via SFTP, getting "Connection refused" error
119117

120118
**Solution:**
121119
1. Ensure port 22 is exposed in your Pod (Pod > Edit Pod > TCP Ports > Add 22)
122120
2. Restart your Pod after adding the port
123-
3. Re-run `OhMyRunPod --file-transfer` to reconfigure SSH
121+
3. Re-run `OhMyRunpod --file-transfer` to reconfigure SSH
124122
</Accordion>
125123

126-
<Accordion title="Permission Denied When Connecting">
124+
<Accordion title="Permission denied when connecting">
127125
**Problem:** Getting "Permission denied" when trying to connect via SFTP
128126

129127
**Solution:**
@@ -132,34 +130,27 @@ Once SFTP is configured, you can:
132130
3. Verify the port number matches what's shown in the connection details
133131
</Accordion>
134132

135-
<Accordion title="SFTP Client Can't Find Host">
133+
<Accordion title="SFTP client can't find host">
136134
**Problem:** SFTP client cannot resolve the host address
137135

138136
**Solution:**
139137
1. Verify your Pod is running and not stopped
140138
2. Check that you're using the correct IP address and port from the connection details
141-
3. Ensure your network allows outbound connections to the RunPod IP range
139+
3. Ensure your network allows outbound connections to the Runpod IP range
142140
</Accordion>
143141
</AccordionGroup>
144142

145143
## Tips
146144

147-
<Tip>
148-
The password is automatically saved to `/workspace/root_password.txt` for your reference.
149-
</Tip>
150-
151-
<Tip>
152-
For large file transfers, use a dedicated SFTP client like FileZilla or WinSCP instead of command line.
153-
</Tip>
145+
- The password is automatically saved to `/workspace/root_password.txt` for your reference.
146+
- For large file transfers, use a dedicated SFTP client like FileZilla or WinSCP instead of the command line.
154147

155-
## More Community Solutions
148+
## More community solutions
156149

157-
<Info>
158-
Have a tool that solves common RunPod problems? Community contributions are welcome! Share your solutions in the RunPod Discord community.
159-
</Info>
150+
Have a tool that solves common Runpod problems? Community contributions are welcome! Share your solutions in the [Runpod Discord](https://discord.gg/runpod) community.
160151

161-
## Related RunPod Documentation
152+
## Related Runpod documentation
162153

163-
- [Official SSH Configuration Guide](/pods/configuration/use-ssh)
154+
- [SSH Configuration Guide](/pods/configuration/use-ssh)
164155
- [Managing Pods](/pods/manage-pods)
165156
- [Connecting to Pods](/pods/connect-to-a-pod)

community-solutions/overview.mdx

Lines changed: 5 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -1,28 +1,16 @@
11
---
2-
title: "Community Lab"
3-
description: "Community-created tools and solutions for Runpod users"
2+
title: "Introduction"
3+
description: "Community-created tools and solutions by and for Runpod users"
44
icon: "flask"
55
---
66

7-
<Note>
8-
**About Community Lab**
9-
107
This section showcases innovative tools and solutions created by the Runpod community. These are tools and workflows developed by users who encountered common challenges and built creative solutions to share with others.
118

129
While these tools and solutions are not officially maintained by Runpod, we highlight them here because they demonstrate the ingenuity of our community and can be valuable resources for users facing similar challenges.
13-
</Note>
14-
15-
## What you'll find here
16-
17-
The Runpod community is incredibly creative and collaborative. When users encounter workflow challenges or repetitive tasks, they often develop or use existing tools and scripts to streamline their work. This section documents some of the most helpful community contributions.
1810

19-
These solutions typically address real-world scenarios like simplifying file transfers to and from Pods, automating Pod setup and configuration, handling Pod migration when resources become unavailable, and creating better user interfaces for common tasks.
11+
## Using community solutions
2012

21-
## Using Community Lab tools
22-
23-
<Info>
24-
Community tools and solutions are provided as-is and maintained by their creators. While we showcase them for their utility, please note that you should test in a development environment first, review source code when available, report issues to the tool creators, and use at your own discretion.
25-
</Info>
13+
Community tools and solutions are provided as-is and maintained by their creators. While we showcase them for their utility, please note that you should test in a development environment first, review the source code when available, report issues to the tool creators, and ultimately use them at your own discretion.
2614

2715
## Featured tools & solutions
2816

@@ -58,16 +46,4 @@ Browse through our community tools section in the sidebar for detailed documenta
5846

5947
## Contributing
6048

61-
Have you built something useful for Runpod? The community would love to learn about it! Share your tools and get feedback in the [Runpod Discord](https://discord.gg/runpod).
62-
63-
## Need official support?
64-
65-
For official Runpod features and support:
66-
- [Main documentation](/overview).
67-
- [API reference](/api-reference/pods/POST/pods).
68-
- [Runpod CLI](/runpodctl/overview).
69-
- [Contact support](https://contact.runpod.io/).
70-
71-
---
72-
73-
*The tools and solutions in this section represent the creativity and problem-solving spirit of the Runpod community. While unofficial, they can significantly improve your workflow and productivity.*
49+
Have you built something useful for Runpod? The community would love to learn about it! Share your tools and get feedback in the [Runpod Discord](https://discord.gg/runpod).

0 commit comments

Comments
 (0)