Skip to content

Commit

Permalink
Updated README.md, removed FUNDING.yml, updated Issue Templates
Browse files Browse the repository at this point in the history
  • Loading branch information
dkattan committed Jun 8, 2023
1 parent 495e347 commit 1df9a82
Show file tree
Hide file tree
Showing 4 changed files with 16 additions and 49 deletions.
3 changes: 0 additions & 3 deletions .github/FUNDING.yml

This file was deleted.

18 changes: 6 additions & 12 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,28 +8,20 @@ assignees: ''
---

<!--
PLEASE READ:
Thank you for your interest in Remotely. Please understand that Remotely is a hobby project that I develop in between working full time and raising a family.
As such, the time I can devote toward the project is very limited, and I simply don't have the availability to help with issues related to hosting or configuration, or ones that aren't specifically related to the application code.
Your bug must meet the following requirements, or else it will be closed. For issues that don't meet these requirements, please reach out to the community on the official subreddit (https://www.reddit.com/r/remotely_app/) or in the Discussion areas on GitHub.
Requirements:
- You are running Remotely in Docker using our official image
-
- The bug must be related specifically to application code (e.g. not related to hosting, reverse proxy configuration, etc.).
- It must be immediately reproducible, either in a debug environment or on https://app.remotely.one. (This doesn't apply to bugs that are clearly code-related.)
- Repro steps must be included. The more information, the better. Pretend you're getting a support request from one of your clients, and think about the kinds of details you want them to include.
- Remotely does not support localization. If the bug is related to language or regional settings, there is likely little I can do.
Again, thank you for your interest in the project, and thank you for your understanding.
-->

**Describe the bug**
A clear and concise description of what the bug is.
A clear and concise description of what the bug is. Ideally with a screenshot if applicable.

**To Reproduce**
Steps to reproduce the behavior:
Expand All @@ -54,10 +46,12 @@ If applicable, add screenshots to help explain your problem.
- Version [e.g. 22]

**Smartphone (please complete the following information):**
- Device: [e.g. iPhone6]
- Device: [e.g. iPhone13]
- OS: [e.g. iOS8.1]
- Browser [e.g. stock browser, safari]
- Version [e.g. 22]

**Additional Context**
Add any other context about the problem here.

- [ ] I am running Remotely in Docker and not on my QNAP, Synology, or Internet Connected Toaster
2 changes: 1 addition & 1 deletion .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,4 +17,4 @@ A clear and concise description of what you want to happen.
A clear and concise description of any alternative solutions or features you've considered.

**Additional context**
Add any other context or screenshots about the feature request here.
Add any other context, mockups or screenshots about the feature request here.
42 changes: 9 additions & 33 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,12 @@ A remote control and remote scripting solution, built with .NET, Blazor, and Sig
[![Tests](https://github.com/immense/Remotely/actions/workflows/run_tests.yml/badge.svg?branch=master)](https://github.com/immense/Remotely/actions/workflows/run_tests.yml)

# Status
## 2022-05-19
Immense Networks is the proud new owner of Remotely. We intend to keep Remotely fully open-source.

I (Darren Kattan) had followed this project since the moment Jared shared it on r/msp years ago. While Jared was writing Remotely, we were writing our own tool for MSPs called ImmyBot, primarily focused on automation and software deployment. Jared and I had similar goals and he felt that we would be good custodians of the project.

ImmyBot experienced explosive growth this year and we only have 4 developers which is why there hasn't been much activity here. We did a big push earlier this year to build an integration between Remotely and ImmyBot but ran into some technical challenges trying to keep only one agent on machines, but we don't want to cannibalize Remotely for the gain of ImmyBot. We want to keep Remotely fully operable as a standalone project. When we resume this initiate later this year, you will likely abstraction of the Remotely.Desktop code into a shared library that can be consumed by Remotely as well as other agents like ImmyBot.
This project is alive! Jared has joined the ImmyBot Team and we have implemented Remotely's Remote Control functionality into ImmyBot.

The shared functionality has been abstracted into the [Immense Remote Control Library](https://github.com/immense/remotecontrol) repository.

This allows both projects to benefit from improvements we make.
## Project Links
Subreddit: https://www.reddit.com/r/remotely_app/
Docker: https://hub.docker.com/r/immybot/remotely
Expand All @@ -23,7 +21,7 @@ Tutorial: https://www.youtube.com/watch?v=t-TFvr7sZ6M (Thanks, @bmcgonag!)
## Quickstart
```
mkdir -p /var/www/remotely
docker run -d --name remotely --restart unless-stopped -p 5000:5000 -v /var/www/remotely:/remotely-data immybot/remotely:latest
docker run -d --name remotely --restart unless-stopped -p 5000:5000 -v /var/www/remotely:/remotely-data immybot/remotely:latest
```

## Important: HTTPS and Reverse Proxies
Expand All @@ -38,7 +36,8 @@ The Remotely code does not parse or handle these values. It is done internally
To avoid injection attacks, ASP.NET Core defaults to only accepting forwarded headers from loopback addresses. Remotely will also add the default Docker host IP (172.17.0.1). If you are using a non-default configuration, you must add all fireawll and reverse proxy addresses to the `KnownProxies` array in appsettings.json.

## After Installation
- Data for Remotely will be saved in `/var/www/remotely/` within two files: appsettings.json and Remotely.db.
- Data for Remotely will be saved in the container under `/remotely-data` which will be mounted to `/var/www/remotely/` on your Docker host
- within two files: appsettings.json and Remotely.db.
- These files will persist through teardown and setup of new Remotely containers.
- If upgrading from a non-Docker version of Remotely, overwrite these files with the ones from your previous installation.
- In that case, please note that you may need to change _SQLite_ parameter in your non-Docker appsettings.json. You may have something like:
Expand Down Expand Up @@ -74,27 +73,6 @@ You must explicitly set a log level for `Microsoft.AspNetCore.HttpLogging.HttpLo

After changing the above, you must restart the container for the changes to take effect.

## Alternative Hosting Methods
Starting in 2023, Docker will be the only supported way of hosting Remotely. Given the number of Linux distributions and other enviromental unknowns, it will be easier to create a consistently reliable deployment process if we focus on Docker. Also, the server is now able to dynamically embed the server/organization data into the EXE while it's downloading, so hard-coding the information in a custom build is no longer necessary.

Nevertheless, Remotely can still be hosted using a service manager (e.g. `systemd`) and `dotnet`. We still provide the Linux x64 binaries in each GitHub release that will work on most major distros. Please refer to the [official documentation](https://learn.microsoft.com/en-us/aspnet/core/host-and-deploy/) that addresses most hosting scenarios.

If you still need to build from source, the `Publish.ps1` script will continue to work, as it's used when building the Docker image. Below is an example of what I was using to build and publish to my local test server before moving to Docker.

Please note, no further support will be provided for these alternative hosting methods. If you're unfamiliar with running your own ASP.NET Core app, it's recommended that you use Docker.

```
$Root = "C:\repos\Remotely"
Set-Location -Path $Root
$VersionString = git show -s --format=%ci
$VersionDate = [DateTimeOffset]::Parse($VersionString)
$CurrentVersion = $VersionDate.ToString("yyyy.MM.dd.HHmm")
&"$Root\Utilities\Publish.ps1" -rid ubuntu-x64 -outdir "C:\publish"
scp -r "$Drive\publish\*" "jared@cubey:/var/www/remotely-test/"
ssh jared@cubey sudo systemctl restart remotely-test
```

## Build and Debug Instructions (Windows 11)
The following steps will configure your Windows 11 machine for building the Remotely server and clients.
* Install Visual Studio 2022.
Expand All @@ -121,8 +99,7 @@ The following steps will configure your Windows 11 machine for building the Remo
## Admin Accounts
The first account created will be an admin for both the server and the organization that's created for the account.

An organization admin has access to the Organization page and server log entries specific to his/her organization. A server admin has access to the Server Config page and can see server log entries that don't belong to an organization.

An organization admin has access to the Organization page and server log entries specific to his/her organization. A server admin has access to the Server Config page and can see server log entries that don't belong to an organization.

## Branding
Within the Account section, there is a tab for branding, which will apply to the quick support clients and Windows installer.
Expand Down Expand Up @@ -162,9 +139,8 @@ By default, Remotely uses a SQLite database. When first run, it creates a file
You can change database by changing `DBProvider` in `ApplicationOptions` to `SQLServer` or `PostgreSQL`.

## Logging
* On clients, logs are kept in %temp%\Remotely_Logs.log.
* For the Agent running as a Windows service, this maps to C:\Windows\Temp\Remotely_Logs.log.
* On the server, some event information is explicitly written to the EventLogs table in the database.
* On clients, logs are kept in `%ProgramData%\Remotely\Logs`
* Within the server container, logs will be written to `/var/www/remotely` which if using our Docker command above will be mounted to `/remotely-data` can be found in /remotely-data
* Built-in ASP.NET Core logs are written to the console (stdout). You can redirect this to a file if desired.
* In IIS, this can be done in the web.config file by setting stdoutLogEnabled to true.
* On Windows Servers, the above logs can also be written to the Windows Event Log.
Expand Down

0 comments on commit 1df9a82

Please sign in to comment.