Mateusz Kaczyński

Apr 33 min read

SFTP - remote editing *.txt

Updated: Apr 30

KB000003

Jeśli chodzi o odczyt plików *.txt na serwerze, najczęściej wystarczy prosty edytor tekstu dostępny z poziomu wiersza poleceń. Co jednak gdy, trzeba dokonać pewnych zmian. Okazuje się że nie wszyscy użytkownicy potrafią lub w ogóle chcą pracować na takich narzędziach jak nano, vim, micro, emacs. W związku z tym może pojawić się potrzeba uruchomienia pliku w gedit czy IDE.

W tym artykule pokaże na przykładzie narzędzia 'SSHFS' oraz WebStorm jak inaczej dokonywać zmian w plikach konfiguracyjnych

Nim przejdę dalej poczynię pewne założenia:

Musisz mieć dostęp do serwera i możliwość wykonywania na nim operacji jako administrator
Posiadasz WebStorm
Posiadasz urządzenie lokalne z zainstalowanym >=Ubuntu 22.04.4 LTS
Używasz Ubuntu Server 22.04.4 LTS do własnych potrzeb
Nie instalowałeś wcześniej 'SSHFS'
Masz skonfigurowane ssh zamiast hasła

SSHFS

Krótko o tym narzędziu:

pomaga edytować, pobierać i przesyłać pliki,
umożliwia dalszą eskalację uprawnień po zamontowaniu,
ułatwia automatyzację zadań takich jak synchronizacja, kopiowanie, wdrażanie apki,
korzystają z tego deweloperzy, administratorzy a nawet użytkownicy domowi

Twórcą jest Miklos Szeredi, autor m.in FUSE która jest platformą dla tego narzędzia.

Instalacja i wymiana

wykonaj polecenie na serwerze oraz na swoim systemie:

sudo apt update && sudo apt install sshfs

po zainstalowaniu zmontuj folder za pomocą:

sshfs username@hostname:/remote/directory /local/mount/point

Gdzie:

username możesz pozyskać za pomocą 'whoami'
a jako hostname możesz podać IP serwera

jeżeli już nie potrzebujesz, odmontuj za pomocą:

umount /local/path

Dlaczego akurat to polecenie a nie: 'fusermount -u /local/path'

Użycie rekomendowanego polecenia sprawdza czy któryś plik nie jest otwarty. Jeśli jest, operacja zostanie przerwana. 'fusermount -u /local/path' nie wykonuje sprawdzenia co może być przydatne w niektórych scenariuszach, ale jest uważane za mniej bezpieczne. Każdy dodatkowy krok może uchronić przed poważnymi konsekwencjami.

I tu drobna uwaga. Być może wymagana będzie zmiana uprawnień do plików tak aby można było je również edytować. W tym celu uruchom polecenie:

chmod u+rw ~/<plik>

lub

sudo chmod u+rw /etc/...

Dokumentacja

To tyle. Jak widzisz jest to dość szybka metoda. Jeśli chcesz dowiedzieć się więcej na temat tego narzędzia zajrzyj do:

https://discovery.endeavouros.com/arm/homeserver-use-fuse-and-sshfs-to-view-server-data-in-a-file-manager/2021/03/

lub

https://wiki.archlinux.org/title/SSHFS

lub

https://www.digitalocean.com/community/tutorials/how-to-use-sshfs-to-mount-remote-file-systems-over-ssh

WebStorm

Świetne IDE do pracy z technologiami webowymi. Integracja z Ubuntu obejmuje możliwość instalacji WebStorm za pomocą menedżera pakietów, takiego jak apt, oraz możliwość uruchamiania go w tym środowisku bez większych problemów.

To czego można użyć w programie do pracy zdalnej na plikach to funkcja o nazwie 'Deployment'. Ponieważ główny wątek to edycja plików *.txt, *.sh, pominę szeroki opis wszystkich funkcjonalności.

Konfiguracja SFTP

Uruchom aplikację i przejdź do:

Settings > Build, Execution, Deployment > użyj znaku "+" aby dodać nowe połączenie

Następnie wybierz z listy 'SFTP', dodaj nową nazwę serwera i przejdź do konfiguracji 'SSH' za pomocą trzech kropek przy liście rozwijanej

W oknie konfiguracji uzupełnij wymagane pola. Tu przyda się już znajomości danych administracyjnych:

w polu host wprowadź adres IP
w polu port podaj numer portu ( 22 - domyślny dla ssh )
w polu username wprowadź dane z whoami serwera
jako typ autoryzacji wybierz 'Key pair'
w polu Passphrase wprowadź hasło które zostało podane podczas generowania ssh-keygen

Po uzupełnieniu danych kliknij przycisk 'TEST CONNECTION'

Zostaniesz przekierowany z powrotem do głównej strony konfiguratora, gdzie będzie możliwe wykonanie ww. testu połączenia. Kliknij ponownie przycisk 🔴️Test Connection. Wynik pozytywny wygląda następująco:

W kolejnym kroku w polu 'Root path' na stronie głównej konfiguratora, wprowadź ścieżkę do katalogu na serwerze. Ta struktura będzie widoczna w twoim lokalnym systemie.

Dla ułatwienia zaznacz również

Nawiązanie połączenia - przegląd struktury

W związku z powodzeniem testu połączenia oraz poprawną konfiguracją, można przystąpić do przeglądania struktury. Uruchom w WebStorm szybkie wyszukiwanie ( 3x SHIFT ) i wprowadź frazę: 'Remote Host'

Jeśli nic nie zmieniono w layout, po prawej stronie edytora powinno pojawić się okno dialogowe

Stan początkowy po otwarciu to <no default server>. To co trzeba zrobić to za pomocą listy rozwijanej, wybrać nazwę hosta. Po wybraniu powinny pojawić się dwa komunikaty:

oraz

Użyj hyper linku do otwarcia okna autoryzacji i wprowadź ponownie 'Passphrase'. Zaznacz checkbox 'SAVE' dla ułatwienia pracy podczas bieżącej sesji