{"id":19445302,"url":"https://github.com/kosmtik/kosmtik-deploy","last_synced_at":"2025-10-23T08:00:21.205Z","repository":{"id":23048581,"uuid":"26401700","full_name":"kosmtik/kosmtik-deploy","owner":"kosmtik","description":"Deploy your Kosmtik project on a remote server.","archived":false,"fork":false,"pushed_at":"2020-09-12T18:21:13.000Z","size":11,"stargazers_count":2,"open_issues_count":0,"forks_count":0,"subscribers_count":3,"default_branch":"master","last_synced_at":"2025-01-21T19:01:49.666Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"JavaScript","has_issues":false,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/kosmtik.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2014-11-09T16:34:47.000Z","updated_at":"2020-09-12T18:21:15.000Z","dependencies_parsed_at":"2022-08-21T18:30:39.365Z","dependency_job_id":null,"html_url":"https://github.com/kosmtik/kosmtik-deploy","commit_stats":null,"previous_names":[],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kosmtik%2Fkosmtik-deploy","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kosmtik%2Fkosmtik-deploy/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kosmtik%2Fkosmtik-deploy/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/kosmtik%2Fkosmtik-deploy/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/kosmtik","download_url":"https://codeload.github.com/kosmtik/kosmtik-deploy/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":240630098,"owners_count":19831990,"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-10T16:09:54.669Z","updated_at":"2025-10-23T08:00:16.147Z","avatar_url":"https://github.com/kosmtik.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# Kosmtik-deploy\n\nDeploy your Kosmtik project on a remote server. Only SSH supported for now.\n\nExperimental, not suited for production use.\n\n\n## Install\n\nWhile in your kosmtik root, type:\n\n`node index.js plugins --install kosmtik-deploy`\n\n## Usage\n\nOnly command line for now. Eg.:\n```\nnode index.js deploy ~/Code/maps/transilien/project.yml\n```\n\nGet details about the available options with:\n```\nnode index.js deploy -h\n```\n\nAll the options can also be set in your project config file (.mml/.yml),\nusing the `deploy` key. For example:\n\n```javascript\n{\n    \"protocol\": \"ssh\",  // optional, as it's the default (and only one supported)\n    \"username\": \"foo\",\n    \"password\": \"123456\",\n    \"root\": \"xxx/yyyy/zzz\",  // remote root where to scp your project\n    \"ignore\": ['this/dir', 'this/file.txt']  // paths to be ignored, can be regex,\n    \"include\": ['this/dir', 'this/file.txt']  // paths of files and dirs to be included (default to project root)\n    \"xml\": \"mapnik.xml\"  // Name of the created Mapnik XML\n}\n```\n\nIf you are using public key based authentication, you can use one those option:\n- you are on a Unix system and your private key is `~/.ssh/id_rsa`: do nothing, it will be automatic\n- add a `privateKeyPath` key with the path to your private key\n- add a `privateKey` key with your SSH private key content\n\nSSH is managed under the hood by the [ssh2 module](https://github.com/mscdex/ssh2), so you may\nhave a look there to get more details about the available options (you can use all of those in your\n`project.yml` `deploy` key).\n\nAlso, remember that you can use your local config file to manage project config information your don't\nwant to visible in the versionned `project.yml/.mml` file.\n\nHere is an example of a `localconfig.js` file:\n```\nexports.LocalConfig = function (localizer, project) {\n    project.mml.compareUrl = 'http://{s}.tile.thunderforest.com/transport/{z}/{x}/{y}.png';\n    localizer.where('Layer').if({'Datasource.type': 'postgis'}).then({\n        'Datasource.dbname': 'idf',\n        'Datasource.password': '',\n        'Datasource.user': 'ybon',\n        'Datasource.host': ''\n    });\n    project.mml.deploy = {\n        host: 'xxxx.kimsufi.com',\n        root: 'maps/transilien'\n    };\n};\n\n```\n\n## Issues and feature requests\n\nPlease report any issue or feature request on the [main kosmtik repository](https://github.com/kosmtik/kosmtik/issues)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkosmtik%2Fkosmtik-deploy","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fkosmtik%2Fkosmtik-deploy","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fkosmtik%2Fkosmtik-deploy/lists"}