Readme.io ve Readme.io SSL desteğiyle nasıl kullanılır?

Tarik Ozket
Dec 23, 2014 · 3 min read

SaaS sağlayıcıların başarılarının büyük bir kısmını kullanışlılığa ve titiz dokümantasyona borçlu olduklarına inanıyoruz. Bu yüzden Pushmote’u geliştirirken dikkat ettiğimiz noktaların başında kullanışlılık ve dokümantasyon geliyor. Şirket içinde Atlassian ürünleri aracılığıyla benimsediğimiz SDLC kültürü sayesinde, kullanışlılığa kolaylıkla dikkat edebiliyor, sürüm çıkmadan önce testler yapabiliyor ve sürüm çıktıktan sonra da atik değişikliklerde bulunabiliyoruz.

Ancak dokümantasyon yapımız için aynılarını söylemek bugüne kadar zordu. Çünkü dokümanlarımızı yazabileceğimiz, derleyebileceğimiz, sürümlendirebileceğimiz, örnek API çağrılarını anlaşılır ve basit bir şekilde gösterebileceğimiz ve hepsinden önemlisi bunları hızlı bir şekilde yazabileceğimiz adanmış bir ortama sahip değildik. Böyle bir ortamı Wordpress üzerinde yaptığımız kişiselleştirmeler ile oluşturmaya çalışıyorduk ancak yaptığımız her kişiselleştirme hem Wordpress’e hemen hemen her ay gelen güncellemeleri yüklememizi ve bakım yapmamızı zorlaştırıyordu hem de zaman ve enerji kaybetmemize neden oluyordu. Ta ki, geçtiğimiz hafta Readme.io ile tanışana kadar.

Readme.io’daki arkadaşlarımız tam olarak bu ihtiyaçları yerinde tespit etmiş ve sundukları servis ile nokta atışı çözümlere imza atmış bulunuyorlar. Readme.io sayesinde dokümanlarımızı artık kolayca sürümlendirebiliyor, örnek API çağrılarını anlaşılır ve basit bir şekilde gösterebiliyor(hatta kullanıcılarınıza atadığınız çerezler aracılığıyla kendi API token’larını kullanarak bu örnekleri gösterebiliyorsunuz), kategorilendirme yapabiliyor ve sürümlerimizde yaptığımız atik değişiklikleri hızlı ve kolay bir şekilde dokümante edebiliyoruz. Bunların ötesinde kullanıcılarımızın da dokümanlarımıza katkıda bulunmalarına olanak sağlayabiliyoruz.

Readme.io homepage

Readme.io’da SSL desteğini nasıl aktif ettik?

Google, SSL ile güvenliklendirilmiş sayfaları arama sonuçlarında önceliklendireceğini duyurduğunda Pushmote’da “HTTPS Everywhere” felsefesini benimsedik ve tüm sayfalarımızda HTTPS kullanmaya başladık. Bunun sonucu olarak da dokümanlarımız da HTTPS ile erişilir hale geldi.

Dokümanlarımızı Readme.io’ya taşıdığımızda “docs” subdomainimizi CNAME ile Readme.io’ya yönlendirdik. Yaşadığımız tek sıkıntı dashboard’umuzdan dokümanlarımıza verdiğimiz “https://” ile başlayan bağlantılar oldu. Readme.io’nun SSL sertifikası desteği mevcut değildi(olsaydı bile, bir servis sağlayıcı olarak SSL sertifikamızı başka servislerle böyle kolay paylaşıyor olmak SSL’in ve kullanıcılarımıza sunmaya çalıştığımız güvenli ortamın amacına uygun olmazdı). Bu yüzden kullanıcılarımız bu bağlantılara tıklandığında aşağıdaki ekran görüntüsü ile karşılaşmaya başlamışlardı.

Without SSL support, our users faced with the security warning and block.

Henüz bir saat geçmiş değildi ki, bir kullanıcımızdan dokümanlarımızın çalışmadığına ve girmeye çalıştığında güvenli olmadığına dair bir ibareyle karşılaştığına dair bir email aldık. Dashboardumuzda bulunan bağlantıları hızlıca değiştirebilirdik ancak HTTPS kullanmaktan vazgeçmek istemiyorduk. Bu yüzden bir çözüm arayışına girdik ve ardından aklımıza CloudFlare’in “Flexible SSL” özelliği geldi. Sunucunuza bir nedenden dolayı SSL kuramıyorsanız ve kullanıcınıza HTTPS trafiği sunmak istiyorsanız, bu özellik tam olarak sizin için biçilmiş kaftan.

CloudFlare Flexible SSL çalışma mantığı.

Not: Flexible SSL, CloudFlare tarafından nadir durumlarda kullanılması tavsiye edilen bir özellik ve CloudFlare bir diğer özelliği olan “Full SSL”(CloudFlare ile sizin sunucunuzun arasındaki trafiğin de şifrelenmiş olduğu)’den daha az güvenli olduğunu hatırlatıyor.

Zaten DNS kayıtlarımızı yönetmek için CloudFlare’i kullandığımız için, bu özelliği dokümanlarımızda aktif etmemiz çok kolay oldu. Yaptığımız işlem şöyleydi:

Hepsi bu kadar! Artık dokümanlarımız HTTPS desteği ile çalışıyordu ve kullanıcılarımız sıkıntısız bir şekilde eski bağlantılar aracılığıyla dokümanlara ulaşabiliyorlardı.


TL;DR

Readme.io’ya taşındıktan sonra “docs” subdomainimizi CNAME aracılığıyla Readme.io’ya yönlendirdik. Ancak Readme.io’da SSL desteği bulunmadığından dolayı(olsaydı bile, bir servis sağlayıcı olarak SSL sertifikamızı başka servislerle böyle kolay paylaşıyor olmak SSL’in ve kullanıcılarımıza sunmaya çalıştığımız güvenli ortamın amacına uygun olmazdı) kullanıcılarımız ‘güvensiz sayfa, devam etmeyiniz’ uyarılarıyla karşılaşmaya başladılar. Cloudflare’in Flexible SSL özelliğini kullanarak tüm sorunu çok kısa bir şekilde çözdük.

    Tarik Ozket

    Written by

    I don’t worry.