{"id":19731372,"url":"https://github.com/clpsplug/coreserver-ip-setter","last_synced_at":"2025-02-27T20:26:10.395Z","repository":{"id":255825853,"uuid":"853692152","full_name":"Clpsplug/coreserver-ip-setter","owner":"Clpsplug","description":"Python tool to allow current machine's IP address to access Coreserver V1 servers from.","archived":false,"fork":false,"pushed_at":"2024-09-16T01:47:10.000Z","size":15,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"base","last_synced_at":"2025-01-10T17:53:41.151Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Clpsplug.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2024-09-07T09:03:43.000Z","updated_at":"2024-09-16T01:47:13.000Z","dependencies_parsed_at":"2024-09-07T10:28:59.665Z","dependency_job_id":"ca9150a8-f156-45c1-b859-7b17a20ee7c9","html_url":"https://github.com/Clpsplug/coreserver-ip-setter","commit_stats":null,"previous_names":["clpsplug/coreserver-ip-setter"],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Clpsplug%2Fcoreserver-ip-setter","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Clpsplug%2Fcoreserver-ip-setter/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Clpsplug%2Fcoreserver-ip-setter/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Clpsplug%2Fcoreserver-ip-setter/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Clpsplug","download_url":"https://codeload.github.com/Clpsplug/coreserver-ip-setter/tar.gz/refs/heads/base","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":241056358,"owners_count":19901770,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-11-12T00:20:38.287Z","updated_at":"2025-02-27T20:26:10.372Z","avatar_url":"https://github.com/Clpsplug.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Coreserver IP Setter\n\n## What\n\nこのスクリプトを実行したサーバを踏み台にしてSSHできるようにするため、\nCoreserverのサーバ(m39.coreserver.jp)に対して当サーバーのIPアドレスを\nSSH接続元として許可するためのAPIを実行します。\n\n## 前提\n\nこのスクリプトはCoreserver V1でのみ動作します。\n\n## How to run\n`.env` ファイルを作成する必要があります。\n\n```console\n$ cp .env.example .env\n$ $EDITOR .env\n```\n\nコピーした`.env`を次のように設定します。\n```env\n# もし使っているエディタが環境変数マスキングをサポートしている場合は\n# コメントが読めなくなるため、一旦外してください。\nCS_USER= # Coreserverでのユーザー名\nSERVER= # Coreserverで自分に割り当てられたサーバーの FQDN 例えば、mNN.coreserver.jp NNは数値、mはプランによって変化します\nAPI_KEY= # コントロールパネルから取得したAPI Key\n```\n\n\u003e [!CAUTION]\n\u003e `.env` ファイルの管理には十分注意を払ってください。\n\nPyenv (Python) およびPoetryを準備します。\n\nPyenvについては[公式インストーラ](https://github.com/pyenv/pyenv-installer)を利用することができます。\nここではpyenvコマンドが利用できるところまでセットアップできた前提で説明します。\n\nPythonのバージョンは3.12以降を指定します。\n```console\n$ pyenv install --list | grep 3.12\n  3.12.0\n  3.12-dev\n  3.12.1\n  3.12.2\n  ...\n# リストされた 3.12系のPythonの中で最新を覚えておく\n$ pyenv install 3.12.2\n$ git clone https://github.com/clpsplug/coreserver-ip-setter\n$ cd coreserver-ip-setter\n$ pyenv local 3.12.2\n$ pip install poetry\n$ poetry install\n```\n\nこの状態で、次を実行し:\n```console\n$ poetry run python main.py\n```\n\n`run.log` に以下の文が出力されていれば成功です。\n```log\n[2024/09/02 00:00:15] Successfully sent API request for SSH permission\n```\n\nもし `err.log` に何らかの出力があった場合は `.env` ファイルや、\n当サーバから対象Coreserverへの可用性を確認してください。\n\n## NOTE\n\nこのスクリプトは、自サーバのIPを取得するために\n`https://api.ipify.org` へリクエストを行います。\n\n## 定期実行のために\n\ncrontabに登録する際は次のような記述が良いでしょう。 `/path/to/` の部分は環境により変えてください。\n\n\u003e [!IMPORTANT]\n\u003e `/path/to` は２箇所あります。1つめはこのコードに辿り着くための `cd` のパスに、\n\u003e もう一つは `.pyenv` フォルダに辿り着くためのパスに存在します。\n\n```cron\n# m h  dom mon dow   command\n0 0 * * 1 cd /path/to/coreserver-ip-setter \u0026\u0026 /path/to/.pyenv/shims/poetry run python main.py\n```\n\n\u003e [!WARNING]\n\u003e あまり頻繁にこのスクリプトを実行しないでください。\n\u003e 上記のCrontabでは一週間ごと(月曜)に実行されます。\n\u003e また、30日ごとにIP許可はリセットされるため、\n\u003e それ以上の間隔で実行されないようにご注意ください。","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclpsplug%2Fcoreserver-ip-setter","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fclpsplug%2Fcoreserver-ip-setter","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fclpsplug%2Fcoreserver-ip-setter/lists"}