[{"_1":2,"_175":-5,"_176":-5},"loaderData",{"_3":4,"_13":14,"_20":21,"_154":155},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","routes/_layout",{"_15":-5,"_16":17,"_18":17,"_19":11},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","routes/_layout.r.$namespace.$reponame",{"_22":23,"_24":-5,"_25":11,"_26":11,"_27":28,"_29":30,"_31":-5,"_32":11,"_33":34,"_84":85,"_108":109,"_147":-5,"_148":11,"_149":17,"_150":11,"_151":-5,"_152":153},"canonicalUrl","https://hub.docker.com/r/newsdev/geoip/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","newsdev","reponame","geoip","cloudBuildSource","isAutobuildsAvailable","repo",{"_35":36,"_37":38,"_40":41,"_42":43,"_44":11,"_45":46,"_47":48,"_49":50,"_52":30,"_27":28,"_53":54,"_55":-5,"_56":57,"_58":59,"_60":61,"_62":-5,"_63":64,"_65":66,"_67":11,"_68":28,"_69":70,"_75":17,"_76":77,"_81":28,"_82":83},"categories",[],"content_types",[39],"image","date_registered","2015-04-28T20:03:53.095141Z","description","","is_private","last_updated","2016-07-01T04:03:08.159306Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[51],"application/vnd.docker.container.image.v1+json","name","pull_count",581920,"repository_type","star_count",3,"status",1,"status_description","active","source","collaborator_count",0,"full_description","# GeoIP\n\n## Description\n\nA simple, Node-based service for providing geolocation data based on a user's IP address. Backed by the MaxMind DB. Also includes a JavaScript plugin for querying the service and handling the response.\n\n* [Features](#features)\n* [Requirements](#requirements)\n* [Support](#support)\n* [Installation](#installation)\n* [Usage](#usage)\n * [Geoip Service](#geoip-service)\n * [Client-side JS](#client-side-js)\n* [Other Relevant Documentation](#other-relevant-documentation)\n* [License](#license)\n\n## Features\n\n* Capable of handling homepage traffic\n* Works with and without RequireJS\n* Decorates `` tag with `geo-`patterned classes, like Modernizr and NYT5\n* Enables CSS fairly complex display rules for states before/after class logic\n* Pretty fast\n\n## Support\n\nPlease add [Issues to this repo on Github](https://github.com/newsdev/geoip/issues/new).\n\n## Local Development\n\n### Client-side JS\n\n#### Local development\n\nJavaScript dependencies like grunt can be installed via NPM:\n\n```\nnpm install\n```\n\nChanges should be made to `frontend/geoip.js`.\n\n~~Please add tests to `frontend/spec/geoipSpec.js`~~ (Tests currently not working).\n\n#### Publishing\n\nMinify your latest version of the script by running `grunt uglify`.\n\nOnce you have uglified the script, upload it to `https://int.nyt.com/applications/geoip/geo.min.js` or `http://int.stg.nyt.com/applications/geoip/geo.min.js`. \n\nTo upload it, run `rake publish DEPLOY_HOST=[int.nyt.com or int.stg.nyt.com] AWS_CONFIG_PATH=[keys]`.\n\nFor details about the keys, see the documentation in [Preview](http://newsdev.ec2.nytimes.com/preview/2016-03-21-geoip-examples/master/) [NYT ONLY].\n\n#### Tests\n\n~~The Jasmine tests can be run via PhantomJS using grunt: `grunt jasmine`.~~ (Tests currently not working).\n\n## Server\n\n\n#### On OS X\n\nSince the server requires GNU tar, you'll likely find it easiest to develop locally on OS X by building and then running a docker image:\n\n```\ndocker build -t geoip . && docker run --name geoip --rm -p 80:80 -e MAXMIND_DATABASE_URL=...S3-path-to/GeoIPCity.tar.gz -e AIRBRAKE_PROJECT_ID=...your_id... -e AIRBRAKE_API_KEY=..your_key... -e ORIGIN_RE=\"/^https?:\\/\\/([\\w-]+\\.)*yourdomain\\.com(:\\d+)?$/\" -e NODE_ENV=production geoip\n```\n\nTo develop locally against your docker image, ping your locally running service like this:\n\n`curl -vv -H \"Origin: http://www.nytimes.com\" [your_docker_image_IP]:80/?ip=170.149.100.10`\n\nYou should then get a response like\n\n`{\"response\":true,\"data\":{\"country_code\":\"US\",\"country_code3\":\"USA\",\"country_name\":\"United States\",\"region\":\"NY\",\"city\":\"New York\",\"postal_code\":\"10018\",\"latitude\":40.75529861450195,\"longitude\":-73.99240112304688,\"metro_code\":501,\"dma_code\":501,\"area_code\":212,\"continent_code\":\"NA\",\"time_zone\":\"America/New_York\",\"zone_abbr\":\"ET\",\"fips_state\":\"36\",\"fips_county\":\"061\"},\"status\":\"ok\"}`\n\nFor more details and deployment steps for the server image, [check out the DevOps wiki](https://github.com/newsdev/devops/wiki/Geoip) [NYT only]. \n\n#### On other platforms\n\nRun `npm start`.\n\n## Usage\n\n### Client-side JS\n\n#### How to Include the JS\n\nThis plugin is intended to be used on NYT5 pages, and has a RequireJS module variant. It can also be used in a non-RJS environment. \n\nThe script itself defines but does not *require* an AMD module, so to initialize it you need to require the module:\n\nFor example:\n\n```html\n\n\n```\n\nUse the same basic format to add your own custom logic for handling the response from our geoip service:\n\n```html\n\n\n```\n\n#### Default behavior\n\nWhen the client-side script is instantiated on the page, it will automatically apply a subset of geocoded data as classes to the `html` tag. Styles can then be written to show/hide elements depending on geolocation per session.\n\nHere are the properties promoted to classes on `html`:\n\n* `geo-continent-NA`: Continent as a code, from [this list](http://dev.maxmind.com/geoip/geoip2/web-services/#continent-10)\n* `geo-country-US`: Country as a code, from [this list](https://www.iso.org/obp/ui/#search/code/)\n* `geo-region-NY`: State/province or equivalent as a code\n* `geo-dma-501`: Media Market code, from [this list](https://developers.google.com/adwords/api/docs/appendix/cities-DMAregions)\n* `geo-postal-10014`: Postal code, for [34 countries in this list](https://www.maxmind.com/en/geoip2-city-database-accuracy)\n* `geo-timezone-America/New_York`: the reader's timezone\n* `geo-us-timezone-ET`: the American reader's timezone in shorthand\n\nFor a response from the geoip service that looks like this:\n\n```json\n{\n \"response\": true,\n \"data\": {\n \"country_code\": \"US\",\n \"country_code3\": \"USA\",\n \"country_name\": \"United States\",\n \"region\": \"NY\",\n \"city\": \"New York\",\n \"postal_code\": \"10018\",\n \"latitude\": 40.755298614502,\n \"longitude\": -73.992401123047,\n \"metro_code\": 501,\n \"dma_code\": 501,\n \"area_code\": 212,\n \"continent_code\": \"NA\",\n \"time_zone\": \"America\\/New_York\",\n \"zone_abbr\": \"ET\",\n \"fips_state\": \"36\",\n \"fips_county\": \"061\"\n },\n \"status\": \"ok\"\n}\n```\n\nthe following will use it to control content options:\n\n```html\n\n

I will be shown for other readers.

I will show for readers in the NYC DMA.

\n\n\n```\n\nIf you want the visibilty of one element to always be the inverse of another's (depending on the criteria defined for the latter), you can show/hide content with `:not()` rules within your CSS.\n\n```html\n\n

I will show for readers in NYC.

I will be hidden for readers in NYC.

I will show for readers not in Kansas.

\n\n\n```\n\n## Other Relevant Documentation\n\n*Links here to external documentation that might help someone using or developing in this project. For example:*\n\n* [Jasmine](http://jasmine.github.io/2.3/introduction.html) - A behavior-driven development framework for testing JavaScript code\n\n\n## License\n\n*Include and licence information here.*\n","has_starred","hub_user","immutable_tags_settings",{"_71":11,"_72":73},"enabled","rules",[74],".*","is_automated","permissions",{"_78":17,"_79":11,"_80":11},"read","write","admin","user","storage_size",1334238758,"orgData",{"_86":87,"_88":89,"_90":91,"_92":28,"_93":94,"_95":96,"_97":98,"_99":100,"_101":102,"_103":104,"_105":43,"_106":43,"_107":17},"id","44144a2474c011e4bea40242ac11001b","uuid","44144a24-74c0-11e4-bea4-0242ac11001b","type","organization","orgname","full_name","Interactive News","location","New York, NY","company","New York Times","profile_url","http://nytimes.com/","date_joined","2014-03-07T20:30:54.8784Z","gravatar_url","https://www.gravatar.com/avatar/0fbc113fa2f853393e365ef02cac236c?s=80&r=g&d=mm","gravatar_email","badge","is_active","recentTags",[110],{"_111":39,"_112":113,"_114":115,"_116":117,"_86":118,"_119":120,"_45":136,"_137":113,"_138":28,"_139":51,"_52":140,"_141":142,"_143":126,"_144":136,"_145":61,"_146":17},"content_type","creator",13898,"digest","sha256:dcbf71911ee063786cf7d21635dbf54c2d56be7adea3b49f031be24e54188bae","full_size",324044212,158759,"images",[121],{"_122":123,"_114":115,"_124":43,"_125":126,"_127":128,"_129":130,"_131":43,"_132":-5,"_133":134,"_58":61,"_135":-5},"architecture","amd64","features","last_pulled","2026-09-15T13:41:19.902321648Z","last_pushed","2016-07-01T04:03:08Z","os","linux","os_features","os_version","size",324043924,"variant","2016-07-01T04:03:06.011415Z","last_updater","last_updater_username","media_type","latest","repository",190330,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.tags",{"_33":156,"_163":164,"_152":173,"_174":11},{"_35":157,"_37":158,"_40":41,"_42":43,"_44":11,"_45":46,"_47":48,"_49":159,"_52":30,"_27":28,"_53":54,"_55":-5,"_56":57,"_58":59,"_60":61,"_62":-5,"_63":64,"_65":66,"_67":11,"_68":28,"_69":160,"_75":17,"_76":162,"_81":28,"_82":83},[],[39],[51],{"_71":11,"_72":161},[74],{"_78":17,"_79":11,"_80":11},"tags",{"_165":59,"_166":-5,"_167":-5,"_168":169},"count","next","previous","results",[170],{"_111":39,"_112":113,"_114":115,"_116":117,"_86":118,"_119":171,"_45":136,"_137":113,"_138":28,"_139":51,"_52":140,"_141":142,"_143":126,"_144":136,"_145":61,"_146":17},[172],{"_122":123,"_114":115,"_124":43,"_125":126,"_127":128,"_129":130,"_131":43,"_132":-5,"_133":134,"_58":61,"_135":-5},[],"canDeleteTags","actionData","errors"]

newsdev/geoip

Tags for newsdev/geoip